Class ImageResource

Resource type for HTMLImageElement.

Memberof

PIXI

Hierarchy (View Summary)

BaseImageResource
- ImageResource

Index

Constructors

constructor

new ImageResource(
source: string | HTMLImageElement,
options?: IImageResourceOptions,
): ImageResource
Parameters
- source: string | HTMLImageElement
  image source or URL
- Optionaloptions: IImageResourceOptions
  - OptionalalphaMode?: ALPHA_MODES
    Premultiply image alpha in bitmap.
  - OptionalautoLoad?: boolean
    Start loading process automatically when constructed.
  - OptionalcreateBitmap?: boolean
    Whether its required to create a bitmap before upload.
  - Optionalcrossorigin?: string | boolean
    Load image using cross origin.
Returns ImageResource
Overrides BaseImageResource.constructor

Properties

`Readonly`alphaMode

alphaMode: ALPHA_MODES

Controls texture alphaMode field Copies from options Default is null, copies option from baseTexture

bitmap

bitmap: ImageBitmap

The ImageBitmap element created for a HTMLImageElement.

Default

null

createBitmap

createBitmap: boolean

If capable, convert the image using createImageBitmap API.

Default

PIXI.settings.CREATE_IMAGE_BITMAP

`Readonly`destroyed

destroyed: boolean

If resource has been destroyed.

Default

false

internal

internal: boolean

true if resource is created by BaseTexture useful for doing cleanup with BaseTexture destroy and not cleaning up resources that were created externally.

preserveBitmap

preserveBitmap: boolean

If the image should be disposed after upload

Default

false

`Readonly`source

source: ImageSource

The source element.

Member

src

src: string

The url of the resource

url

url: string

URL of the image source

Accessors

height

get height(): number
The height of the resource.

Returns number
Inherited from BaseImageResource.height

valid

get valid(): boolean
Has been validated

Returns boolean
Inherited from BaseImageResource.valid

width

get width(): number
The width of the resource.

Returns number
Inherited from BaseImageResource.width

Methods

bind

bind(baseTexture: BaseTexture): void
Bind to a parent BaseTexture
Parameters
- baseTexture: BaseTexture
  Parent texture
Returns void
Inherited from BaseImageResource.bind

destroy

destroy(): void
Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

Returns void
Inherited from BaseImageResource.destroy

dispose

dispose(): void
Destroys this resource.

Returns void
Overrides BaseImageResource.dispose

load

load(createBitmap?: boolean): Promise<ImageResource>
Returns a promise when image will be loaded and processed.
Parameters
- OptionalcreateBitmap: boolean
  whether process image into bitmap
Returns Promise<ImageResource>
Overrides BaseImageResource.load

process

process(): Promise<ImageResource>
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
Inherited from BaseImageResource.resize

style

style(
    _renderer: Renderer,
    _baseTexture: BaseTexture,
    _glTexture: GLTexture,
): boolean
Set the style, optional to override
Parameters
- _renderer: Renderer
  yeah, renderer!
- _baseTexture: BaseTexture
  the texture
- _glTexture: GLTexture
  texture instance for this webgl context
Returns boolean
- true is success
Inherited from BaseImageResource.style

unbind

unbind(baseTexture: BaseTexture): void
Unbind to a parent BaseTexture
Parameters
- baseTexture: BaseTexture
  Parent texture
Returns void
Inherited from BaseImageResource.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
Inherited from BaseImageResource.update

upload

upload(
    renderer: Renderer,
    baseTexture: BaseTexture,
    glTexture: GLTexture,
): boolean
Upload the image resource to GPU.
Parameters
- renderer: Renderer
  Renderer to upload to
- baseTexture: BaseTexture
  BaseTexture for this resource
- glTexture: GLTexture
  GLTexture to use
Returns boolean
true is success

Overrides BaseImageResource.upload

`Static`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
- Optionalcrossorigin: string | boolean
  Cross origin value to use
Returns void
Inherited from BaseImageResource.crossOrigin

`Static`test

test(source: unknown): source is string | HTMLImageElement
Used to auto-detect the type of resource.
Parameters
- source: unknown
  The source object
Returns source is string | HTMLImageElement
true if current environment support HTMLImageElement, and source is string or HTMLImageElement

Overrides BaseImageResource.test

Class ImageResource

Memberof

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalalphaMode?: ALPHA_MODES

OptionalautoLoad?: boolean

OptionalcreateBitmap?: boolean

Optionalcrossorigin?: string | boolean

Returns ImageResource

Properties

ReadonlyalphaMode

bitmap

Default

createBitmap

Default

Readonlydestroyed

Default

internal

preserveBitmap

Default

Readonlysource

Member

src

url

Accessors

height

Returns number

valid

Returns boolean

width

Returns number

Methods

bind

Parameters

Returns void

destroy

Returns void

dispose

Returns void

load

Parameters

Returns Promise<ImageResource>

process

Returns Promise<ImageResource>

resize

Parameters

Returns void

style

Parameters

Returns boolean

unbind

Parameters

Returns void

update

Returns void

upload

Parameters

Returns boolean

StaticcrossOrigin

Parameters

Returns void

Statictest

Parameters

Returns source is string | HTMLImageElement

Settings

On This Page

`Optional`alphaMode?: ALPHA_MODES

`Optional`autoLoad?: boolean

`Optional`createBitmap?: boolean

`Optional`crossorigin?: string | boolean

`Readonly`alphaMode

`Readonly`destroyed

`Readonly`source

`Static`crossOrigin

`Static`test