class `SpriteGlyph`

Inherits: CoreVariantType<SpriteImage, false>

Implementation of SpriteImage that renders a single glyph from a Font.

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.

staticCreate

static HSpriteGlyph Create(const HFont &font, u32 glyph, float size = 8.F)

Creates a new sprite glyph.

staticCreate

static HSpriteGlyph Create(const SpriteGlyphCreateInformation &createInformation)

Creates a new sprite glyph.

staticCreateShared

static SPtr<SpriteGlyph> CreateShared(const HFont &font, u32 glyph, float size = 8.F)

Creates a new SpriteGlyph without a resource handle.

Use Create() for normal use.

staticCreateShared

static SPtr<SpriteGlyph> CreateShared(const SpriteGlyphCreateInformation &createInformation)

Creates a new SpriteGlyph 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

SpriteGlyph

SpriteGlyph(const SpriteGlyphCreateInformation &createInformation)

Methods

AllocateImage

SPtr<SpriteGlyphAllocation> AllocateImage(float sizeInPoints)

Allocates a sprite image using the provided size in points.

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.

staticCreateEmpty

static SPtr<SpriteGlyph> CreateEmpty()

Creates a new empty and uninitialized sprite glyph.

Fields

mFont

HFont mFont

mGlyph

u32 mGlyph

mDefaultGlyphSize

float mDefaultGlyphSize