Class TextureAbstract

constructor

• new Texture(txManager): Texture

• Parameters

  • txManager: CoreTextureManager

  Returns Texture

Readonly dimensions

Readonly error

Readonly lastRenderableChangeTime

preventCleanup

Readonly renderable

Readonly renderableOwners

Readonly state

type

ctxTexture

• get ctxTexture(): CoreContextTexture

• Get the CoreContextTexture for this Texture

  Returns CoreContextTexture

  Remarks

  Each Texture has a corresponding CoreContextTexture that is used to manage the texture's native data depending on the renderer's mode (WebGL, Canvas, etc).

  The Texture and CoreContextTexture are always linked together in a 1:1 relationship.

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

Optional onChangeIsRenderable

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

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.

setState

• setState<State>(state, ...args): void

• Set the state of the texture

  Type Parameters

  • State extends TextureState

  Parameters

  • state: State

  • Rest ...args: ParametersSkipTarget<TextureStateEventMap[State]>

  Returns void

  Remark

  Intended for internal-use only but declared public so that it can be set by it's associated CoreContextTexture

Static makeCacheKey

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

Static resolveDefaults

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