Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImageResource

Resource type for HTMLImageElement.

memberof

PIXI

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _height

_height: number

Private _load

_load: any

Private _process

_process: any

Protected _width

_width: number

alphaMode

alphaMode: ALPHA_MODES

bitmap

bitmap: ImageBitmap

createBitmap

createBitmap: boolean

destroyed

destroyed: boolean

internal

internal: boolean

noSubImage

noSubImage: boolean

Protected onError

onError: Runner

Protected onResize

onResize: Runner

Protected onUpdate

onUpdate: Runner

preserveBitmap

preserveBitmap: boolean

source

source: ImageSource

url

url: string

Accessors

height

  • get height(): number

  • The height of the resource.

    member

    {number}

    readonly

    Returns number

valid

  • get valid(): boolean

  • Has been validated

    readonly
    member

    {boolean}

    Returns boolean

width

  • get width(): number

  • The width of the resource.

    member

    {number}

    readonly

    Returns number

Methods

bind

destroy

  • destroy(): void

  • Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

    Returns void

dispose

  • dispose(): void

  • Destroys this texture

    override

    Returns void

load

  • returns a promise when image will be loaded and processed

    Parameters

    • Optional createBitmap: boolean

    Returns Promise<ImageResource>

process

  • Called when we need to convert image into BitmapImage. Can be called multiple times, real promise is cached inside.

    Returns Promise<ImageResource>

    cached promise to fill that bitmap

resize

  • resize(width: number, height: number): void

  • Trigger a resize event

    Parameters

    • width: number

      X dimension

    • height: number

      Y dimension

    Returns void

style

unbind

update

  • update(): void

  • Checks if source width/height was changed, resize can cause extra baseTexture update. Triggers one update in any case.

    Returns void

upload

Static Protected crossOrigin

  • crossOrigin(element: HTMLImageElement | HTMLVideoElement, url: string, crossorigin?: string | boolean): void

  • Set cross origin based detecting the url and the crossorigin

    Parameters

    • element: HTMLImageElement | HTMLVideoElement

      Element to apply crossOrigin

    • url: string

      URL to check

    • Optional crossorigin: string | boolean

    Returns void

Static test

  • test(source: unknown): source is string | HTMLImageElement

  • Used to auto-detect the type of resource.

    static

    Parameters

    • source: unknown

      The source object

    Returns source is string | HTMLImageElement

    true if source is string or HTMLImageElement

Generated using TypeDoc