class `SpriteImageAllocation`

Inherits: CoreObject, TSpriteImageAllocation<false>

Public

virtual ~SpriteImageAllocation() noexcept

static SPtr<SpriteImageAllocation> Create(const WeakSPtr<SpriteImage> &owner, const HTexture &atlasTexture, const Area2 &uvRange)

Creates a new sprite image allocation.

virtual ~TSpriteImageAllocation<IsRenderProxy>() = default

const TextureType &GetTexture() const

Retrieves the texture where the image is stored.

Size2I GetSize() const

Returns the pixel size of the UV subrange covered in the texture atlas.

If the image includes animation, this will return the size of the entire animation grid.

Area2 GetUVRange() const

Determines the UV range that the image is referencing.

Vector2 TransformUV(const Vector2 &uv) const

Transforms local UV coordinates into atlas UV coordinates.

SPtr<render::RenderProxy> CreateRenderProxy() const override

Creates an object that contains render thread specific data and methods for this object.

Can be null if such object is not required.

RenderProxySyncPacket *CreateRenderProxySyncPacket(FrameAllocator &allocator, u32 flags) override

Creates a data packet that will be used for syncing the core object with it's render proxy.

Caller must free the retrieved packet using the provided allocator when done using it.

WeakSPtr<SpriteImageType> mOwner

Owner sprite image that this allocation is a part of.

Texture within which the image is allocated.

Area2 mUVRange

Range in the atlas texture that the image is to be read from, in [0, 1] range.