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 full)

Texture
- ImageTexture

Constructors

constructor

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

Properties

ctxTexture

ctxTexture: undefined | CoreContextTexture

`Readonly`dimensions

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.

`Readonly`error

error: null | Error = null

`Readonly`lastRenderableChangeTime

lastRenderableChangeTime = 0

preventCleanup

preventCleanup: boolean = false

props

props: Required<ImageTextureProps>

`Readonly`renderable

renderable: boolean = false

`Readonly`renderableOwners

renderableOwners: Set<unknown> = ...

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

Methods

createImageBitmap

createImageBitmap(blob, premultiplyAlpha, sx, sy, sw, sh): Promise<{
data: ImageBitmap | HTMLImageElement;
premultiplyAlpha: boolean;
}>
Parameters
- blob: Blob
- premultiplyAlpha: null | boolean
- sx: null | number
- sy: null | number
- sw: null | number
- sh: null | number
Returns Promise<{
data: ImageBitmap | HTMLImageElement;
premultiplyAlpha: boolean;
}>
- Defined in src/core/textures/ImageTexture.ts:158

determineImageTypeAndLoadImage

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

emit

emit(event, data?): 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:263

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:370

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:229

hasAlphaChannel

hasAlphaChannel(mimeType): boolean
Parameters
- mimeType: string
Returns boolean
- Defined in src/core/textures/ImageTexture.ts:131

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:249

loadImage

loadImage(src): Promise<TextureData>
Parameters
- src: string
Returns Promise<TextureData>
- Defined in src/core/textures/ImageTexture.ts:204

loadImageFallback

loadImageFallback(src, hasAlpha): Promise<{
data: HTMLImageElement;
premultiplyAlpha: boolean;
}>
Parameters
- src: string
- hasAlpha: boolean
Returns Promise<{
data: HTMLImageElement;
premultiplyAlpha: boolean;
}>
- Defined in src/core/textures/ImageTexture.ts:135

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
Inherited from Texture.off
- Defined in src/common/EventEmitter.ts:41

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
Inherited from Texture.on
- Defined in src/common/EventEmitter.ts:32

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
Inherited from Texture.once
- Defined in src/common/EventEmitter.ts:56

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

removeAllListeners

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

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

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

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

`Static`makeCacheKey

makeCacheKey(props): 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:337

`Static`resolveDefaults

resolveDefaults(props): 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:360

Class ImageTexture

Remarks

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ImageTexture

Properties

ctxTexture

Readonlydimensions

Remarks

Readonlyerror

ReadonlylastRenderableChangeTime

preventCleanup

props

Readonlyrenderable

ReadonlyrenderableOwners

state

textureData

ProtectedtxManager

type

Staticz$__type__Props

Methods

createImageBitmap

Parameters

Returns Promise<{ data: ImageBitmap | HTMLImageElement; premultiplyAlpha: boolean; }>

determineImageTypeAndLoadImage

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

emit

Parameters

Returns void

free

Returns void

Remarks

getTextureData

Returns Promise<TextureData>

Remarks

getTextureSource

Returns Promise<TextureData>

Remarks

hasAlphaChannel

Parameters

Returns boolean

loadCtxTexture

Returns CoreContextTexture

loadImage

Parameters

Returns Promise<TextureData>

loadImageFallback

Parameters

Returns Promise<{ data: HTMLImageElement; premultiplyAlpha: boolean; }>

off

Parameters

Parameters

Returns void

Returns void

on

Parameters

Parameters

Returns void

Returns void

once

Parameters

Parameters

Returns void

Returns void

OptionalonChangeIsRenderable

Parameters

Returns void

Remarks

removeAllListeners

Returns void

setCoreCtxState

Parameters

Returns void

Remarks

`Readonly`dimensions

`Readonly`error

`Readonly`lastRenderableChangeTime

`Readonly`renderable

`Readonly`renderableOwners

`Protected`txManager

`Static`z$typeProps

Returns Promise<{
data: ImageBitmap | HTMLImageElement;
premultiplyAlpha: boolean;
}>

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

Returns Promise<{
data: HTMLImageElement;
premultiplyAlpha: boolean;
}>

`Optional`onChangeIsRenderable

`Static`makeCacheKey

`Static`resolveDefaults