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)

Constructors

constructor

Properties

ctxTexture dimensions error preventCleanup props renderable renderableOwners state textureData txManager type z$__type__Props

Methods

createImageBitmap determineImageTypeAndLoadImage emit free freeTextureData getTextureData getTextureSource hasAlphaChannel load loadCtxTexture loadImage loadImageFallback off on once onChangeIsRenderable? removeAllListeners setRenderableOwner setState makeCacheKey resolveDefaults

Constructors

constructor

Properties

ctxTexture

ctxTexture: undefined | CoreContextTexture

Readonlydimensions

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.

Readonlyerror

error: null | Error = null

preventCleanup

preventCleanup: boolean = false

props

props: Required<ImageTextureProps>

Readonlyrenderable

renderable: boolean = false

ReadonlyrenderableOwners

renderableOwners: Set<unknown> = ...

state

state: TextureState = 'initial'

textureData

textureData: null | TextureData = null

ProtectedtxManager

txManager: CoreTextureManager

type

type: TextureType = TextureType.image

Staticz$__type__Props

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;
    }>

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;
    }

emit

free

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

getTextureSource

hasAlphaChannel

load

loadCtxTexture

loadImage

loadImageFallback

  • loadImageFallback(src, hasAlpha): Promise<{
        data: HTMLImageElement;
        premultiplyAlpha: boolean;
    }>

  • Parameters

    • src: string
    • hasAlpha: boolean

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

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

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

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

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.

removeAllListeners

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

StaticmakeCacheKey

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

StaticresolveDefaults

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods