Class TextureAbstract

Represents a source of texture data for a CoreContextTexture.

Remarks

Texture sources are used to populate a CoreContextTexture when that texture is loaded. Texture data retrieved by the CoreContextTexture by the getTextureData method. It's the responsibility of the concerete Texture subclass to implement this method appropriately.

Hierarchy (view full)

Constructors

constructor

Properties

ctxTexture dimensions error lastRenderableChangeTime preventCleanup renderable renderableOwners state textureData txManager type

Methods

emit free getTextureData getTextureSource loadCtxTexture off on once onChangeIsRenderable? removeAllListeners setCoreCtxState setRenderableOwner setSourceState makeCacheKey resolveDefaults

Constructors

constructor

Properties

ctxTexture

ctxTexture: undefined | CoreContextTexture

Readonlydimensions

dimensions: null | Readonly<Dimensions> = null

The dimensions of the texture

Remarks

Until the texture data is loaded for the first time the value will be null.

Readonlyerror

error: null | Error = null

ReadonlylastRenderableChangeTime

lastRenderableChangeTime = 0

preventCleanup

preventCleanup: boolean = false

Readonlyrenderable

renderable: boolean = false

ReadonlyrenderableOwners

renderableOwners: Set<unknown> = ...

state

state: TextureState = 'initial'

textureData

textureData: null | TextureData = null

ProtectedtxManager

txManager: CoreTextureManager

type

type: TextureType = TextureType.generic

Methods

emit

free

  • free(): void

  • Free the core context texture for this Texture.

    Returns void

    Remarks

    The ctxTexture is created by the renderer and lives on the GPU.

getTextureData

  • getTextureData(): Promise<TextureData>

  • Get the texture data for this texture.

    Returns Promise<TextureData>

    The texture data for this texture.

    Remarks

    This method is called by the CoreContextTexture when the texture is loaded. The texture data is then used to populate the CoreContextTexture.

AbstractgetTextureSource

  • getTextureSource(): Promise<TextureData>

  • Get the texture source for this texture.

    Returns Promise<TextureData>

    Remarks

    This method is called by the CoreContextTexture when the texture is loaded. The texture source is then used to populate the CoreContextTexture.

loadCtxTexture

  • loadCtxTexture(): CoreContextTexture

  • Load the core context texture for this Texture. The ctxTexture is created by the renderer and lives on the GPU.

    Returns CoreContextTexture

off

  • off(event, listener?): void

  • Parameters

    • event: string
    • Optionallistener: ((target: any, data: any) => void)
        • (target, data): void

        • Parameters

          • target: any
          • data: any

          Returns void

    Returns void

on

  • on(event, listener): void

  • Parameters

    • event: string
    • listener: ((target: any, data: any) => void)
        • (target, data): void

        • Parameters

          • target: any
          • data: any

          Returns void

    Returns void

once

  • once(event, listener): void

  • Parameters

    • event: string
    • listener: ((target: any, data: any) => void)
        • (target, data): void

        • Parameters

          • target: any
          • data: any

          Returns void

    Returns void

OptionalonChangeIsRenderable

  • onChangeIsRenderable(isRenderable): void

  • Event called when the Texture becomes renderable or unrenderable.

    Parameters

    • isRenderable: boolean

      true if this Texture has renderable owners.

    Returns void

    Remarks

    Used by subclasses like SubTexture propogate then renderability of the Texture to other referenced Textures.

removeAllListeners

setCoreCtxState

  • setCoreCtxState(state, errorOrDimensions?): void

  • Set the core context state of the texture

    Parameters

    • state: TextureState

      State of the texture

    • OptionalerrorOrDimensions: Error | Dimensions

      Error or dimensions of the texture

    Returns void

    Remarks

    The core context state of the texture is the state of the texture on the GPU.

setRenderableOwner

  • setRenderableOwner(owner, renderable): void

  • Add/remove an owner to/from the Texture based on its renderability.

    Parameters

    • owner: unknown
    • renderable: boolean

    Returns void

    Remarks

    Any object can own a texture, be it a CoreNode or even the state object from a Text Renderer.

    When the reference to the texture that an owner object holds is replaced or cleared it must call this with renderable=false to release the owner association.

setSourceState

  • setSourceState(state, errorOrDimensions?): void

  • Set the source state of the texture

    Parameters

    • state: TextureState

      State of the texture

    • OptionalerrorOrDimensions: Error | Dimensions

      Error or dimensions of the texture

    Returns void

    Remarks

    The source of the texture can either be generated by the texture itself or loaded from an external source.

StaticmakeCacheKey

  • makeCacheKey(props): string | false

  • Make a cache key for this texture.

    Parameters

    • props: unknown

    Returns string | false

    A cache key for this texture or false if the texture type does not support caching.

    Remarks

    Each concrete Texture subclass must implement this method to provide an appropriate cache key for the texture type including the texture's properties that uniquely identify a copy of the texture. If the texture type does not support caching, then this method should return false.

StaticresolveDefaults

  • resolveDefaults(props): Record<string, unknown>

  • Resolve the default values for the texture's properties.

    Parameters

    • props: unknown

    Returns Record<string, unknown>

    The default values for the texture's properties.

    Remarks

    Each concrete Texture subclass must implement this method to provide default values for the texture's optional properties.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods