RSX Code Reference
    Preparing search index...

    Class Image

    A abstract resource class for images.

    Images can be a segment in a texture sprite, a glyph in a font or a single GPU texture. Optionally, some implementations might support animations by using multiple sprite frames by specifying a sprite sheet animation by varying which portion of the UV is selected over time.

    The image resource is an abstract class. In order to use it, you must use one of it's implementations:

    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 sprite texture that references the entire area of the provided texture.

      Parameters

      • texture: Texture
      • OptionalisInternalConstructor: boolean

      Returns Image

    • 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.

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods