Class: BaseImageResource

Extends

• PIXI.resources.Resource

Members

_height number protected inherited

Internal height of the resource

_width number protected inherited

Internal width of the resource

destroyed boolean readonly inherited

If resource has been destroyed

Default Value:

• false

height number readonly inherited

The height of the resource.

internal boolean protected inherited

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

source HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | SVGElement readonly

The source element

valid boolean readonly inherited

Has been validated

width number readonly inherited

The width of the resource.

Methods

PIXI.resources.BaseImageResource.crossOrigin (element, url, crossorigin) protectedstatic

BaseImageResource.js:36

Set cross origin based detecting the url and the crossorigin

Name	Type	Default	Description
element	HTMLElement		Element to apply crossOrigin
url	string		URL to check
crossorigin	boolean | string	true	optional Cross origin value to use

bind (baseTexture) inherited

Resource.js:75

Bind to a parent BaseTexture

Name	Type	Description
baseTexture	PIXI.BaseTexture	Parent texture

destroy () inherited

Resource.js:207

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

dispose () protected inherited overrides

Resource.js:197

Clean up anything, this happens when destroying is ready.

load ()Promise.<void> protected inherited

Resource.js:139

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

Returns:

Type	Description
Promise.<void>	Handle the validate event

resize () inherited

Resource.js:102

Trigger a resize event

style (renderer, baseTexture, glTexture)boolean inherited

Resource.js:187

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) inherited

Resource.js:93

Unbind to a parent BaseTexture

Name	Type	Description
baseTexture	PIXI.BaseTexture	Parent texture

update () inherited

Resource.js:125

Has been updated trigger event

upload (renderer, baseTexture, glTexture, source)boolean overrides

BaseImageResource.js:56

Upload the texture to the GPU.

Name	Type	Description
renderer	PIXI.Renderer	Upload to the renderer
baseTexture	PIXI.BaseTexture	Reference to parent texture
glTexture	PIXI.GLTexture
source	HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | SVGElement	optional (optional)

Returns:

Type	Description
boolean	true is success