Class: BaseTexture

Members

readonlyhasLoadedboolean

Set to true once the base texture has successfully loaded.

This is never true if the underlying source fails to load or has no texture data.

readonlyheightnumber

The height of the base texture set when the image has loaded

imageUrlstring

readonlyisLoadingboolean

Set to true if the source is currently loading.

If an Image source is loading the 'loaded' or 'error' event will be
dispatched when the operation ends. An underyling source that is
immediately-available bypasses loading entirely.

mipmapboolean

Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used
Also the texture must be a power of two size to work

premultipliedAlphaboolean

Controls if RGB channels should be pre-multiplied by Alpha (WebGL only)
All blend modes, and shaders written for default value. Change it on your own risk.

Default Value:

• true

readonlyrealHeightnumber

Used to store the actual height of the source of this texture

readonlyrealWidthnumber

Used to store the actual width of the source of this texture

resolutionnumber

The Resolution of the texture.

scaleModenumber

The scale mode to apply when scaling this texture

Default Value:

• PIXI.SCALE_MODES.DEFAULT

See:

• PIXI.SCALE_MODES

readonlysourceImage Canvas

The image source that is used to create the texture.

TODO: Make this a setter that calls loadSource();

readonlywidthnumber

The width of the base texture set when the image has loaded

Methods

staticPIXI.BaseTexture.fromCanvas(canvas, scaleMode)

core/textures/BaseTexture.js, line 418

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

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

Returns:

PIXI.BaseTexture

staticPIXI.BaseTexture.fromImage(imageUrl, crossorigin, scaleMode)

core/textures/BaseTexture.js, line 377

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

Returns:

PIXI.BaseTexture

destroy()

core/textures/BaseTexture.js, line 316

Destroys this base texture

dispose()

core/textures/BaseTexture.js, line 346

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 209

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	Image | Canvas	the source object of the texture.

update()

core/textures/BaseTexture.js, line 173

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 360

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