Class ImageTexture

Texture consisting of an image loaded from a URL

Remarks

The ImageTexture's ImageTextureProps.src prop defines the image URL to be downloaded.

By default, the texture's alpha values will be premultiplied into its color values which is generally the desired setting before they are sent to the texture's associated Shader. However, in special cases you may want the Shader to receive straight (non-premultiplied) values. In that case you can disable the default behavior by setting the ImageTextureProps.premultiplyAlpha prop to false.

Hierarchy (View Summary)

Texture
- ImageTexture

Constructors

constructor

new ImageTexture(
txManager: CoreTextureManager,
props: Required<ImageTextureProps>,
): ImageTexture
Parameters
- txManager: CoreTextureManager
- props: Required<ImageTextureProps>
Returns ImageTexture
Overrides Texture.constructor
- Defined in src/core/textures/ImageTexture.ts:134

Properties

ctxTexture

ctxTexture: undefined | CoreContextTexture

maxRetryCount

maxRetryCount: number

memUsed

memUsed: number = 0

preventCleanup

preventCleanup: boolean = false

props

props: Required<ImageTextureProps>

`Readonly`renderable

renderable: boolean = false

`Readonly`renderableOwners

renderableOwners: any[] = []

retryCount

retryCount: number = 0

Memory used by this texture in bytes

Remarks

This is tracked by the TextureMemoryManager and updated when the texture is loaded/freed. Set to 0 when texture is not loaded.

state

state: TextureState = 'initial'

textureData

textureData: null | TextureData = null

`Protected`txManager

txManager: CoreTextureManager

type

type: TextureType = TextureType.image

`Static`z$typeProps

z$__type__Props: ImageTextureProps

Accessors

dimensions

get dimensions(): null | Dimensions
Returns null | Dimensions
Inherited from Texture.dimensions
- Defined in src/core/textures/Texture.ts:208

error

get error(): null | TextureError
Returns null | TextureError
Inherited from Texture.error
- Defined in src/core/textures/Texture.ts:212

Methods

canBeCleanedUp

canBeCleanedUp(): boolean
Checks if the texture can be safely cleaned up. Considers the renderable state, startup grace period, and renderable owners.

Returns boolean
Inherited from Texture.canBeCleanedUp
- Defined in src/core/textures/Texture.ts:244

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.
Inherited from Texture.destroy
- Defined in src/core/textures/Texture.ts:377

determineImageTypeAndLoadImage

determineImageTypeAndLoadImage(): | Promise<ImageResponse>
| { data: null; premultiplyAlpha?: undefined }
| { data: null | ImageData; premultiplyAlpha: null | boolean }
Returns
    | Promise<ImageResponse>
    | { data: null; premultiplyAlpha?: undefined }
    | { data: null | ImageData; premultiplyAlpha: null | boolean }
- Defined in src/core/textures/ImageTexture.ts:170

emit

emit(event: string, data?: any): void
Parameters
- event: string
- Optionaldata: any
Returns void
Inherited from Texture.emit
- Defined in src/common/EventEmitter.ts:64

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.
Inherited from Texture.free
- Defined in src/core/textures/Texture.ts:354

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.
Inherited from Texture.freeTextureData
- Defined in src/core/textures/Texture.ts:394

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.
Inherited from Texture.getTextureData
- Defined in src/core/textures/Texture.ts:451

getTextureSource

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.
Overrides Texture.getTextureSource
- Defined in src/core/textures/ImageTexture.ts:145

isWithinStartupGracePeriod

isWithinStartupGracePeriod(): boolean
Checks if the texture is within the startup grace period. During this period, textures are protected from cleanup to prevent race conditions during app initialization.

Returns boolean
Inherited from Texture.isWithinStartupGracePeriod
- Defined in src/core/textures/Texture.ts:221

load

load(): void
Returns void
Inherited from Texture.load
- Defined in src/core/textures/Texture.ts:315

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
Inherited from Texture.loadCtxTexture
- Defined in src/core/textures/Texture.ts:340

off

off(event: string, listener?: (target: any, data: any) => void): void
Parameters
- event: string
- Optionallistener: (target: any, data: any) => void
Returns void
Inherited from Texture.off
- Defined in src/common/EventEmitter.ts:41

on

on(event: string, listener: (target: any, data: any) => void): void
Parameters
- event: string
- listener: (target: any, data: any) => void
Returns void
Inherited from Texture.on
- Defined in src/common/EventEmitter.ts:32

once

once(event: string, listener: (target: any, data: any) => void): void
Parameters
- event: string
- listener: (target: any, data: any) => void
Returns void
Inherited from Texture.once
- Defined in src/common/EventEmitter.ts:56

`Optional`onChangeIsRenderable

onChangeIsRenderable?(isRenderable: boolean): 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.
Inherited from Texture.onChangeIsRenderable
- Defined in src/core/textures/Texture.ts:332

release

release(): void
Release the texture data and core context texture for this Texture without changing state.

Returns void
Remarks
The ctxTexture is created by the renderer and lives on the GPU.
Inherited from Texture.release
- Defined in src/core/textures/Texture.ts:364

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from Texture.removeAllListeners
- Defined in src/common/EventEmitter.ts:74

setRenderableOwner

setRenderableOwner(owner: string | number, renderable: boolean): void
Add/remove an owner to/from the Texture based on its renderability.
Parameters
- owner: string | number
- 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.
Inherited from Texture.setRenderableOwner
- Defined in src/core/textures/Texture.ts:283

setState

setState(
state: TextureState,
errorOrDimensions?: TextureError | Dimensions,
): void
Parameters
- state: TextureState
- OptionalerrorOrDimensions: TextureError | Dimensions
Returns void
Inherited from Texture.setState
- Defined in src/core/textures/Texture.ts:398

`Static`makeCacheKey

makeCacheKey(props: ImageTextureProps): string | false
Generates a cache key for the ImageTexture based on the provided props.
Parameters
- props: ImageTextureProps
  The props used to generate the cache key.
Returns string | false
The cache key as a string, or false if the key cannot be generated.
Overrides Texture.makeCacheKey
- Defined in src/core/textures/ImageTexture.ts:227

`Static`resolveDefaults

resolveDefaults(props: ImageTextureProps): Required<ImageTextureProps>
Resolve the default values for the texture's properties.
Parameters
- props: ImageTextureProps
Returns Required<ImageTextureProps>
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.
Overrides Texture.resolveDefaults
- Defined in src/core/textures/ImageTexture.ts:249

Class ImageTexture

Remarks

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ImageTexture

Properties

ctxTexture

maxRetryCount

memUsed

preventCleanup

props

Readonlyrenderable

ReadonlyrenderableOwners

retryCount

Remarks

state

textureData

ProtectedtxManager

type

Staticz$__type__Props

Accessors

dimensions

Returns null | Dimensions

error

Returns null | TextureError

Methods

canBeCleanedUp

Returns boolean

destroy

Returns void

Remarks

determineImageTypeAndLoadImage

Returns | Promise<ImageResponse> | { data: null; premultiplyAlpha?: undefined } | { data: null | ImageData; premultiplyAlpha: null | boolean }

emit

Parameters

Returns void

free

Returns void

Remarks

freeTextureData

Returns void

Remarks

getTextureData

Returns Promise<TextureData>

Remarks

getTextureSource

Returns Promise<TextureData>

Remarks

isWithinStartupGracePeriod

Returns boolean

load

Returns void

loadCtxTexture

Returns CoreContextTexture

off

Parameters

Returns void

on

Parameters

Returns void

once

Parameters

Returns void

OptionalonChangeIsRenderable

Parameters

Returns void

Remarks

release

Returns void

Remarks

removeAllListeners

Returns void

setRenderableOwner

`Readonly`renderable

`Readonly`renderableOwners

`Protected`txManager

`Static`z$typeProps

Returns
| Promise<ImageResponse>
| { data: null; premultiplyAlpha?: undefined }
| { data: null | ImageData; premultiplyAlpha: null | boolean }

`Optional`onChangeIsRenderable

`Static`makeCacheKey

`Static`resolveDefaults