RSX Code Reference
    Preparing search index...
    • rsx
    • ShapeImage

    Class ShapeImage

    An Image implementation that exposes a shape as an Image. This allows to use a scalable shape as an image, so that the backing bitmap can be redrawn to fit the size when drawing.

    Hierarchy (View Summary)

    Index
    constructor
    handle isDestroyed metaData name referenceHeight referenceWidth texture uuid
    duplicate onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart revert unload

    • Creates a new shape image that references a font shape. The reference size is used when estimating sizes for getReferenceWidth and getReferenceHeight.

      Parameters

      • shape: Shape

        The shape to be used when drawing the image

      • OptionalreferenceSize: Immutable<Size2>

        The size to be used as a reference. The shape will be aspect fitted into this size and that value will be used as the reference size.

      • OptionalisInternalConstructor: boolean

      Returns ShapeImage

    • get isDestroyed(): boolean

      Determines if the resource is destroyed.

      Returns boolean

      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.

    • get name(): string

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

      Returns string

    • get referenceHeight(): number

      Returns reference height of the image texture in pixels.

      Returns number

    • get referenceWidth(): number

      Returns reference width of the image in pixels.

      Returns number

    • get uuid(): UUID

      Returns a universally unique identifier of this resource.

      Returns UUID

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

      Returns Resource

      The duplicated resource or null, if the duplication failed.

    • Virtual

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

      Returns void

    • Virtual

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

      Returns void

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

    • Virtual

      Method called by RSX to disable the resource.

      Returns void

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

    • Virtual

      Method called by RSX to enable the resource.

      Returns void

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

    • Virtual

      Method called by RSX to perform initialization of the resource.

      Returns void

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

    • Virtual

      Method called by RSX to perform any operations before serialization.

      Returns void

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

    • Reverts the resource to the on-disk representation.

      Returns boolean

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

    • Forcefully unloads the resource.

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods