Class TextureAbstract

constructor

• new Texture(txManager): Texture

• Parameters

  • txManager: CoreTextureManager

  Returns Texture

ctxTexture

preventCleanup

Readonlyrenderable

ReadonlyrenderableOwners

state

textureData

type

Static ReadonlyTRANSITIONAL_TEXTURE_STATES

dimensions

• get dimensions(): null | Dimensions

• Returns null | Dimensions

error

• get error(): null | Error

• Returns null | Error

destroy

• destroy(): void

• Destroy the texture.

  Returns void

  Remarks

  This method is called when the texture is no longer needed and should be cleaned up.

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.

freeTextureData

• freeTextureData(): void

• Free the source texture data for this Texture.

  Returns void

  Remarks

  The texture data is the source data that is used to populate the CoreContextTexture. e.g. ImageData that is downloaded from a URL.

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.

load

• load(): void

• Returns void

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

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.

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, errorOrDimensions?): void

• Parameters

  • state: TextureState
  • OptionalerrorOrDimensions: Error | Dimensions

  Returns void

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, any>

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

  Parameters

  • props: unknown

  Returns Record<string, any>

  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.