class `SpriteTexture`

Inherits: CoreVariantType<SpriteImage, false>

Implementation of SpriteImage that uses a user-provided texture as the atlas texture.

Public

Methods

FindOrAllocateImageToFitArea

SPtr<SpriteImageAllocation> FindOrAllocateImageToFitArea(const Size2I &size) override

Attempts to allocate a new image that is of appropriate quality to fit into the provided area.

This is mostly used by vector shapes, which will usually want to re-render themselves to fit the requested size and achieve the best possible quality.

The image will be scaled uniformly until one or both dimensions of the image match the provided size. One dimension may be smaller than the provided size.

Implementations may choose to avoid re-rendering and just return the default allocated image instead, in which case its up to the caller to scale the image appropriately (e.g. using bilinear filtering or scale9grid).

If an existing allocation for the provided size already exists, it will be returned and a new allocation will not be made alive. Allocated portion of the texture will remain alive as long as there is at least a single reference to the returned SpriteImageAllocation.

size: Requested size of the allocation, in physical pixel units.

Returns: Allocation structure that provides information about the allocation and used for tracking allocation lifetime.

FindOrAllocateScaledImage

SPtr<SpriteImageAllocation> FindOrAllocateScaledImage(float scale) override

Attempts to allocate a new image that is of appropriate quality for a scaled version of the default image.

This is mostly used by vector shapes, which will usually want to re-render themselves to fit the requested scale and achieve the best possible quality (e.g. scale may change when display DPI changes, or when user zooms in/out).

scale: Scale to apply.

Returns: Allocation structure that provides information about the allocation and used for tracking allocation lifetime.

GetAtlasTexture

const TextureType &GetAtlasTexture() const

Retrieves the atlas texture where the image is stored.

GetUVRange

const Area2 &GetUVRange() const

Determines the UV range that the image is referencing.

staticCreate

static HSpriteTexture Create(const HTexture &texture)

Creates a new sprite texture that references the entire area of the provided texture.

staticCreate

static HSpriteTexture Create(const SpriteTextureCreateInformation &createInformation)

Creates a new sprite texture that references a sub-area of the provided texture.

staticCreateShared

static SPtr<SpriteTexture> CreateShared(const HTexture &texture)

Creates a new SpriteTexture without a resource handle.

Use Create() for normal use.

staticCreateShared

static SPtr<SpriteTexture> CreateShared(const SpriteTextureCreateInformation &createInformation)

Creates a new SpriteTexture without a resource handle.

Use Create() for normal use.

staticGetRttiStatic

static RTTIType *GetRttiStatic()

GetRtti

RTTIType *GetRtti() const override

Returns an interface you can use to access class' Run Time Type Information.

Private

Constructors

SpriteTexture

SpriteTexture(const SpriteTextureCreateInformation &createInformation)

Methods

Initialize

void Initialize() override

Initializes all the internal data of this object.

Must be called right after construction for new objects, or after deserialization for deserialized objects. If requested, render proxy is created and queued for initialization on the render thread.

CreateRenderProxy

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.

CreateRenderProxySyncPacket

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.

GetCoreDependencies

void GetCoreDependencies(Vector<CoreObject *> &dependencies) override

Populates the provided array with all core objects that this core object depends upon.

Dependencies are required for syncing to the render thread, so the system can be aware to update the dependant objects if a dependency is marked as dirty (for example updating a camera's viewport should also trigger an update on camera so it has a chance to potentially update its data).

staticCreateEmpty

static SPtr<SpriteTexture> CreateEmpty()

Creates a new empty and uninitialized sprite texture.

Fields

mAtlasTexture

TextureType mAtlasTexture

mUVRange

Area2 mUVRange

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