Namespace Unity.Tiny.Core2D
Classes
DisplayListSystem
Collects and sorts entities by camera, and readies them for rendering. Rendering and hit testing do not consider changes made to entities after the display list is created.
GenericAssetLoader<T, TN, TS, L>
Image2DMaskInit
A system that makes sure that Image2DAlphaMaskData is added to images that have the Image2DAlphaMask component. Any image loading systems should be scheduled after this system.
TransformHelpers
Provides a variety of convenience functions for transforms.
UpdateLocalTransformSystem
A system that has to run in order to update the LocalToParent component. Required.
UpdateWorldTransformSystem
A system that has to run in order to update the LocalToWorld component. Required.
Structs
Camera2D
Camera2DAxisSort
Add this component to an entity with a Camera2D component to change the default sorting axis.
Camera2DClippingPlanes
Add this component to an entity with a Camera2D component to specify the distances from the camera to its near and far clipping planes. The camera draws elements between the clipping planes and ignores elements outside of them.
Camera2DRenderToTexture
Add this component to the same entity as Camera2D to render to a texture instead of to the screen.
CameraLayer0
CameraLayer1
CameraLayer10
CameraLayer11
CameraLayer12
CameraLayer13
CameraLayer14
CameraLayer15
CameraLayer2
CameraLayer3
CameraLayer4
CameraLayer5
CameraLayer6
CameraLayer7
CameraLayer8
CameraLayer9
Color
RGBA floating-point color.
DisplayInfo
Configures display-related parameters. You can access this component via TinyEnvironment.Get/SetConfigData<DisplayInfo>()
DisplayListCamera
DisplayListEntry
Image2D
Image2DAlphaMask
A component that keeps a read only alpha mask of an Image2D for use in hit testing, when pixelAccurate hit testing is enabled.
Image2DAlphaMaskData
Image2DLoadFromFile
Initialize an image from an asset file.
Image2DLoadFromFileImageFile
The image file/URI to load. This can be a data URI.
Image2DLoadFromFileMaskFile
An image to use as the mask. This can be a data URI.
Image2DRenderToTexture
Tag component that needs to be next to be placed next to an Image2D component if it is intended to be used as a render to texture target.
LayerSorting
This component tags a node with two additional values that allow sorting by layer and order. The default value for both is 0. The entity you add this component to must have a Transform component.
Entities with a higher layer value overlay entities with a lower layer value. The order value defines how entities with the same layer value are ordered. As with layers, entities with a higher order value overlay those with a lower order value.
Layer sorting happens before order sorting, and both happen before axis sorting. Axis sorting only happens when entities share the same layer and order values.
LayerSorting values are not propagated through the hierarchy.
LocalToParent
The UpdateLocalTransformSystem system adds and updates this component, which provides direct access to the cached object space transform. The object transform is computed from the contents of the NonUniformScale, Rotation, and Translation components. This component is readable and writeable.
LocalToWorld
The UpdateWorldTransformSystem system adds and updates this component, which provides direct access to the cached Object to World space transform. This component is readable and writeable.
NonUniformScale
This is an optional component that specifies a three-axis scale transform. It is optional. If it is not added to the entity, the unit scale (1,1,1) is assumed.
Parent
This component is required for an entity to be part of the transform hierarchy. Entities without this component are not rendered. A root entity's parent entity can be NONE.
PrivateTransformData
This component is read by the DisplayList system for tracking sorting group membership. It is automatically added by the UpdateWorldTransformSystem;
Rect
2D rectangle
RectTransformFinalSize
Add this compoment next to a RectTransform component and a Text2DRenderer (for now) while adding a text in a rect transform
Rotation
This is an optional component that specifies a quaternion rotation transform. If it is not added to the entity, the unit quaternion rotation is assumed.
Scale
This is an optional component that specifies a uniform scale transform. It is optional. If it is not added to the entity, the unit scale (1,1,1) is assumed.
Shape2DIndex
Optional indices into the vertices of the shape.
Shape2DRenderer
A component for basic 2D shape rendering. Specifies how to render Shape2DVertex and Shape2DIndex data.
Shape2DVertex
A component describing a 2d closed polygon shape.
SortedEntity
SortingGroup
This is a flag component that marks the start of a sorting group in a hierarchy. You only need to add this component to the head node (entity) in a group, but that entity must also have a Transform component.
Sorting groups allow you to sort the group head's descendants indepenently. Whatever sorting you apply to the overall hierarchy also happens locally within the group.
Sprite2D
A component describing a sprite as a sub-region of an image. Specifies the source Image2D atlas and the region to use.
Sprite2DBorder
Modifier component. Add alongside a Sprite2D to add a border. The border is used for sliced tiling modes
Sprite2DRenderer
A component for basic 2D sprite rendering. Specifies an Sprite2D to draw and rendering modifiers, such as a color tint.
Sprite2DRendererOptions
A modifier component, when added alongside a Sprite2DRenderer it overrides the world space size computation.
Sprite2DSequence
List of sprite entities, which are required to have Sprite2D components. Add a Sprite2DSequence for additional options.
Sprite2DSequenceOptions
A component that describes the framerate of a list of sprites for animation. Place in the same entity as a Sprite2DSequence.
Sprite2DSequencePlayer
A component that is used by the Unity.Tiny.Core2D.SequencePlayerSystem to play play back a sequence of sprites when applied to an entity that also has the Sprite2DRenderer component.
SpriteAtlas
A component describing a list of Sprite2D packed in an image atlas.
TransformStatic
This is a flag component that marks an entity's transform as static. The entity you add it to must have a Transform component. If an entity transform is marked as static, both its object and world transforms are computed once and not updated again. You can remove the static transform marker at any time to resume transform computations. Note that the TransformStatic tag has no effect on uncached compute functions.
Translation
This is an optional component that specifies a position transform. If it is not attached to the entity, no local translation is assumed.
Interfaces
IExternalDisplayListEntryMaker
IGenericAssetLoader<T, TN, TS, L>
Enums
BlendOp
Blending operation when drawing
CameraClearFlags
List of options for clearing a camera's viewport before rendering. Used by the Camera2D component.
CameraCullingMode
List of options for interpreting a camera's culling mask. These are used by the Camera2D component.
DisplayListEntryType
DisplayOrientation
DrawMode
Drawing mode used by Sprite2DRendererOptions When a sprite size is manually set, the drawing mode specifies how the sprite fills the area.
Image2DMemoryFormat
Image2DSaveStatus
ImageStatus
LoadResult
LoopMode
RenderMode
The rendering mode for DisplayInfo.