PixiJS

Class: ImageBitmapResource

PIXI.ImageBitmapResource

Resource type for ImageBitmap.

new PIXI.ImageBitmapResource (source, options) overrides

ImageBitmapResource.ts:72
Name Type Attributes Description
source ImageBitmap | string

ImageBitmap or URL to use.
options PIXI.IImageBitmapResourceOptions <optional>

Options to use.

Extends

Members

alphaMode PIXI.ALPHA_MODES | null readonly

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

crossOrigin boolean

Load image using cross origin.

Default Value:
  • false

url string | null

URL of the image source.

Methods

PIXI.ImageBitmapResource.test (source) boolean static

ImageBitmapResource.ts:207

Used to auto-detect the type of resource.

Name Type Description
source unknown

The source object
Returns:
Type Description
boolean true if current environment support ImageBitmap, and source is string or ImageBitmap

dispose () void overrides

ImageBitmapResource.ts:194

Destroys this resource.

upload (renderer, baseTexture, glTexture) boolean overrides

ImageBitmapResource.ts:170

Upload the image bitmap resource to GPU.

Name Type Description
renderer PIXI.Renderer

Renderer to upload to
baseTexture PIXI.BaseTexture

BaseTexture for this resource
glTexture PIXI.GLTexture

GLTexture to use
Returns:
Type Description
boolean true is success

Inherited Properties

From class PIXI.BaseImageResource

source PIXI.ImageSourcee readonly inherited

The source element.

From class PIXI.Resource

destroyed boolean readonly inherited

If resource has been destroyed.

Default Value:
  • false

height number readonly inherited

The height of the resource.

internal boolean inherited

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

src string inherited

The url of the resource

valid boolean readonly inherited

Has been validated

width number readonly inherited

The width of the resource.

_height number protected inherited

Internal height of the resource.

_width number protected inherited

Internal width of the resource.

Inherited Methods

From class PIXI.BaseImageResource

update () void inherited

BaseImageResource.ts:114

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

From class PIXI.Resource

bind (baseTexture) void inherited

Resource.ts:79

Bind to a parent BaseTexture

Name Type Description
baseTexture PIXI.BaseTexture

Parent texture

destroy () void inherited

Resource.ts:197

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

resize (width, height) void inherited

Resource.ts:108

Trigger a resize event

Name Type Description
width number

X dimension
height number

Y dimension

style (_renderer, _baseTexture, _glTexture) boolean inherited

Resource.ts:179

Set the style, optional to override

Name Type Description
_renderer PIXI.Renderer

yeah, renderer!
_baseTexture PIXI.BaseTexture

the texture
_glTexture PIXI.GLTexture

texture instance for this webgl context
Returns:
Type Description
boolean
  • true is success

unbind (baseTexture) void inherited

Resource.ts:97

Unbind to a parent BaseTexture

Name Type Description
baseTexture PIXI.BaseTexture

Parent texture

load () Promise<this> protected inherited

Resource.ts:141

This can be overridden to start preloading a resource or do any other prepare step.

Returns:
Type Description
Promise<this> Handle the validate event