Class: BaseTexture

Extends

• EventEmitter

Methods

staticPIXI.BaseTexture.fromCanvas(canvas, scaleMode){PIXI.BaseTexture}

core/textures/BaseTexture.js, line 677

Helper function that creates a base texture from the given canvas element.

Name	Type	Description
canvas	HTMLCanvasElement	The canvas element source of the texture
scaleMode	number	See PIXI.SCALE_MODES for possible values

Returns:

Type	Description
PIXI.BaseTexture	The new base texture.

staticPIXI.BaseTexture.fromImage(imageUrl, crossorigin, scaleMode, sourceScale){PIXI.BaseTexture}

core/textures/BaseTexture.js, line 635

Helper function that creates a base texture from the given image url.
If the image is not in the base texture cache it will be created and loaded.

Name	Type	Default	Description
imageUrl	string		The image url of the texture
crossorigin	boolean	(auto)	optional Should use anonymous CORS? Defaults to true if the URL is not a data-URI.
scaleMode	number	PIXI.SCALE_MODES.DEFAULT	optional See PIXI.SCALE_MODES for possible values
sourceScale	number	(auto)	optional Scale for the original image, used with Svg images.

Returns:

Type	Description
PIXI.BaseTexture	The new base texture.

_loadSvgSource()

core/textures/BaseTexture.js, line 428

Checks if source is an SVG image and whether it's loaded via a URL or a data URI. Then calls
_loadSvgSourceUsingDataUri or _loadSvgSourceUsingXhr.

_loadSvgSourceUsingDataUri(dataUri)

core/textures/BaseTexture.js, line 454

Reads an SVG string from data URI and then calls _loadSvgSourceUsingString.

Name	Type	Description
dataUri	string	The data uri to load from.

_loadSvgSourceUsingString(svgString)

core/textures/BaseTexture.js, line 513

Loads texture using an SVG string. The original SVG Image is stored as origSource and the
created canvas is the new source. The SVG is scaled using sourceScale. Called by
_loadSvgSourceUsingXhr or _loadSvgSourceUsingDataUri.

Name	Type	Description
svgString	string	SVG source as string

Fires:

• event:loaded

_loadSvgSourceUsingXhr()

core/textures/BaseTexture.js, line 477

Loads an SVG string from imageUrl using XHR and then calls _loadSvgSourceUsingString.

_updateImageType()

core/textures/BaseTexture.js, line 389

Updates type of the source image.

destroy()

core/textures/BaseTexture.js, line 575

Destroys this base texture

dispose()

core/textures/BaseTexture.js, line 606

Frees the texture from WebGL memory without destroying this texture object.
This means you can still use the texture later which will upload it to GPU
memory again.

protectedloadSource(source)

core/textures/BaseTexture.js, line 266

Load a source.

If the source is not-immediately-available, such as an image that needs to be
downloaded, then the 'loaded' or 'error' event will be dispatched in the future
and hasLoaded will remain false after this call.

The logic state after calling loadSource directly or indirectly (eg. fromImage, new BaseTexture) is:

if (texture.hasLoaded) {
   // texture ready for use
} else if (texture.isLoading) {
   // listen to 'loaded' and/or 'error' events on texture
} else {
   // not loading, not going to load UNLESS the source is reloaded
   // (it may still make sense to listen to the events)
}

Name	Type	Description
source	HTMLImageElement | HTMLCanvasElement	the source object of the texture.

update()

core/textures/BaseTexture.js, line 228

Updates the texture on all the webgl renderers, this also assumes the src has changed.

Fires:

• event:update

updateSourceImage(newSrc)

core/textures/BaseTexture.js, line 617

Changes the source image of the texture.
The original source must be an Image element.

Name	Type	Description
newSrc	string	the path of the image

Events

error

core/textures/BaseTexture.js, line 214

Fired when a not-immediately-available source fails to load.

loaded

core/textures/BaseTexture.js, line 206

Fired when a not-immediately-available source finishes loading.