Class Font

Font resource containing data about textual characters and how to render text. Contains one or multiple font bitmaps, each for a specific size.

Hierarchy (view full)

Constructors

constructor

Accessors

handle isDestroyed metaData name uuid

Methods

calculateTextSizeInPixels duplicate getClosestSize getData getNearestOrCreateData getOrCreateData getPage getPages isDynamic onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart prepareCharacterSet revert unload

Constructors

Protectedconstructor

Accessors

handle

isDestroyed

  • get isDestroyed(): boolean

  • Determines if the resource is destroyed.

    Returns boolean

    Note

    This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

metaData

name

  • get name(): string

  • Name of the resource. Use primarily for easier identification and not important to the engine itself.

    Returns string

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

Methods

calculateTextSizeInPixels

  • calculateTextSizeInPixels(text, fontSize, maximumWidth): Size2

  • Calculate the dimensions for the text.

    Parameters

    • text: string
    • fontSize: number

      The size of the font.

    • maximumWidth: number

      (Optional) The maximum width to enforce a line breaks.

    Returns Size2

duplicate

  • duplicate(): Resource

  • Duplicates the resource and creates a unique UUID for the duplicated resource.

    Returns Resource

    The duplicated resource or null, if the duplication failed.

getClosestSize

  • getClosestSize(size): number

  • Finds the available font size closest to the provided size.

    Parameters

    • size: number

      Size of the font in points.

    Returns number

    Nearest available font size.

getData

  • getData(size, isLinearlyScaled?): FontData

  • Returns font data for a specific font size. In the case the font is dynamic, this method will not create new data for the given size. Use GetOrCreateData instead.

    Parameters

    • size: number

      Size of the font in points.

    • OptionalisLinearlyScaled: boolean

      Whether or not the font should use linear advancing for glyphs, instead of pixel aligned values.

    Returns FontData

    Data object if it exists, false otherwise.

getNearestOrCreateData

  • getNearestOrCreateData(size, isLinearlyScaled?): FontData

  • Returns font data for a specific font size. If no such data exists and the font IsDynamic() new data will be created. If the font is not dynamic, the nearest baked font data will be returned.

    Parameters

    • size: number

      Size of the font in points.

    • OptionalisLinearlyScaled: boolean

      Whether or not the font should use linear advancing for glyphs, instead of pixel aligned values.

    Returns FontData

    An existing Data object if it exists or a newly created one.

getOrCreateData

  • getOrCreateData(size, isLinearlyScaled?): FontData

  • Returns font data for a specific font size. If no such data exists and the font IsDynamic() new data will be created.

    Parameters

    • size: number

      Size of the font in points.

    • OptionalisLinearlyScaled: boolean

      Whether or not the font should use linear advancing for glyphs, instead of pixel aligned values.

    Returns FontData

    An existing Data object if it exists or a newly created one.

getPage

  • getPage(page): Texture

  • Returns the requested font bitmap texture page.

    Parameters

    • page: number

      The bitmap page index to be returned.

    Returns Texture

    The requested texture page or if not found.

getPages

isDynamic

  • isDynamic(): boolean

  • Checks if the font supports dynamic glyph generation. The font needs FontImporterOptions::dynamic set to true when importing it.

    Returns boolean

onCreate

  • onCreate(): void
  • Virtual

    Method called by RSX to perform actions required after the creation of the resource.

    Returns void

onDeserializationEnded

  • onDeserializationEnded(): void
  • Virtual

    Method called by RSX to perform any operations needed after deserialization.

    Returns void

    Note

    Use this API to restore your serializable data into live objects.

onDisable

  • onDisable(): void
  • Virtual

    Method called by RSX to disable the resource.

    Returns void

    Note

    Use this API to deactivate the resource before it is serialized.

onEnable

  • onEnable(): void
  • Virtual

    Method called by RSX to enable the resource.

    Returns void

    Note

    Use this API to activate the resource after it has been disabled by serialization.

onInitialize

  • onInitialize(): void
  • Virtual

    Method called by RSX to perform initialization of the resource.

    Returns void

    Note

    Use this API to initialize data and default construct all fields.

onSerializationStart

  • onSerializationStart(): void
  • Virtual

    Method called by RSX to perform any operations before serialization.

    Returns void

    Note

    Use this API to bake your live data into serializable data.

prepareCharacterSet

  • prepareCharacterSet(charSet, size, isLinearlyScaled?): boolean

  • Prepares all characters in for rendering. If any character in is not rendered yet, it will be rendered and inserted into a suitable texture page.

    Parameters

    • charSet: string
    • size: number
    • OptionalisLinearlyScaled: boolean

    Returns boolean

    Note

    If the font is not dynamic (IsDynamic() returns then this method does nothing.

revert

  • revert(): boolean

  • Reverts the resource to the on-disk representation.

    Returns boolean

    Note

    This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

unload

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods