Struct Sprite2D
A component describing a sprite as a sub-region of an image. Specifies the source Image2D atlas and the region to use.
Namespace: Unity.Tiny.Core2D
Syntax
public struct Sprite2D : IComponentDataFields
image
The Entity on which to look for a Image2D component to use as the source image. If null, the Image2D is looked for on the same entity as the Sprite2D.
Declaration
[EntityWithComponents(new Type[]{typeof(Image2D)})]
public Entity imageField Value
| Type | Description |
|---|---|
| Entity |
imageRegion
The region of the source image to use as the sprite.
Declaration
public Rect imageRegionField Value
| Type | Description |
|---|---|
| Rect |
Remarks
The image is treated as a unit rectangle; thus this rectangle should use values in the range of 0..1. For example, to use the bottom left portion of the image, the rectangle should go from (0, 0) to (0.5, 0.5)
pivot
The point in the sprite that is the sprite's center. Relative to the bottom-left corner of the sprite, in unit rectangle coordinates.
Declaration
public float2 pivotField Value
| Type | Description |
|---|---|
| float2 |
pixelsToWorldUnits
Conversion ratio of sprite image pixels to world units, e.g.: The default value is 1.
Declaration
public float pixelsToWorldUnitsField Value
| Type | Description |
|---|---|
| System.Single |
Remarks
This should not be used for scaling sprites.