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

Texture
- ImageTexture

Index

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

`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 = 0

preventCleanup

preventCleanup: boolean = false

props

props: Required<ImageTextureProps>

`Readonly` renderable

renderable: boolean = false

`Readonly` renderableOwners

renderableOwners: Set<unknown> = ...

`Readonly` state

state: TextureState = 'freed'

`Protected` txManager

txManager: CoreTextureManager

type

type: TextureType = TextureType.image

`Static` z$typeProps

z$__type__Props: ImageTextureProps

Accessors

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

Methods

emit

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

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

hasAlphaChannel

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

loadImage

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

off

off(event, listener?): void
Parameters
- event: string
- Optional listener: ((target, data) => 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, data) => void)
  - - (target, data): void
    - Parameters
      
      target: any
      
      data: any
      
      Returns void
Returns void
Inherited from Texture.on
- Defined in src/common/EventEmitter.ts:32

`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:216

once

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

removeAllListeners

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

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

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

`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:259

`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:282

Class ImageTexture

Remarks

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

txManager: CoreTextureManager

props: ImageTextureProps

Returns ImageTexture

Properties

Readonly dimensions

Remarks

Readonly error

Readonly lastRenderableChangeTime

preventCleanup

props

Readonly renderable

Readonly renderableOwners

Readonly state

Protected txManager

type

Static z$__type__Props

Accessors

ctxTexture

Returns CoreContextTexture

Remarks

Methods

emit

Parameters

event: string

Optional data: any

Returns void

getTextureData

Returns Promise<TextureData>

Remarks

hasAlphaChannel

Parameters

mimeType: string

Returns boolean

loadImage

Parameters

src: string

Returns Promise<TextureData>

off

Parameters

event: string

Optional listener: ((target, data) => void)

Parameters

target: any

data: any

Returns void

Returns void

on

Parameters

event: string

listener: ((target, data) => void)

Parameters

target: any

data: any

Returns void

Returns void

Optional onChangeIsRenderable

Parameters

isRenderable: boolean

Returns void

Remarks

once

Parameters

event: string

listener: ((target, data) => void)

Parameters

target: any

data: any

Returns void

Returns void

`Readonly` dimensions

`Readonly` error

`Readonly` lastRenderableChangeTime

`Readonly` renderable

`Readonly` renderableOwners

`Readonly` state

`Protected` txManager

`Static` z$typeProps

`Optional` data: any

`Optional` listener: ((target, data) => void)

`Optional` onChangeIsRenderable

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

`Static` makeCacheKey

`Static` resolveDefaults