Class: BaseTexture

Extends

• EventEmitter

Members

hasLoaded boolean readonly

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.

height number readonly

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

imageType string readonly

Type of image defined in source, eg. png or svg

imageUrl string

The image url of the texture

isLoading boolean readonly

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.

mipmap boolean

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

See:

• PIXI.MIPMAP_TEXTURES

origSource Image readonly

The image source that is used to create the texture. This is used to store the original Svg source when it is replaced with a canvas element.

TODO: Currently not in use but could be used when re-scaling svg.

premultipliedAlpha boolean

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

realHeight number readonly

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

realWidth number readonly

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

resolution number

The resolution / device pixel ratio of the texture

Default Value:

• 1

scaleMode number

The scale mode to apply when scaling this texture

Default Value:

• PIXI.settings.SCALE_MODE

See:

• PIXI.SCALE_MODES

source HTMLImageElement | HTMLCanvasElement readonly

The image source that is used to create the texture.

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

sourceScale number readonly

Scale for source image. Used with Svg images to scale them before rasterization.

textureCacheIds Array.<string>

The ids under which this BaseTexture has been added to the base texture cache. This is automatically set as long as BaseTexture.addToCache is used, but may not be set if a BaseTexture is added directly to the BaseTextureCache array.

width number readonly

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

wrapMode number

WebGL Texture wrap mode

See:

• PIXI.WRAP_MODES

Methods

PIXI.BaseTexture.addToCache (baseTexture, id) static

BaseTexture.js:796

Adds a BaseTexture to the global BaseTextureCache. This cache is shared across the whole PIXI object.

Name	Type	Description
baseTexture	PIXI.BaseTexture	The BaseTexture to add to the cache.
id	string	The id that the BaseTexture will be stored against.

PIXI.BaseTexture.from (source, scaleMode, sourceScale)PIXI.BaseTexture static

BaseTexture.js:751

Helper function that creates a base texture based on the source you provide. The source can be - image url, image element, canvas element. If the source is an image url or an image element and not in the base texture cache, it will be created and loaded.

Name	Type	Default	Description
source	string | HTMLImageElement | HTMLCanvasElement		The source to create base texture from.
scaleMode	number	PIXI.settings.SCALE_MODE	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.

PIXI.BaseTexture.fromCanvas (canvas, scaleMode, origin)PIXI.BaseTexture static

BaseTexture.js:721

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

Name	Type	Default	Description
canvas	HTMLCanvasElement		The canvas element source of the texture
scaleMode	number		See PIXI.SCALE_MODES for possible values
origin	string	'canvas'	optional A string origin of who created the base texture

Returns:

Type	Description
PIXI.BaseTexture	The new base texture.

PIXI.BaseTexture.fromImage (imageUrl, crossorigin, scaleMode, sourceScale)PIXI.BaseTexture static

BaseTexture.js:674

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.settings.SCALE_MODE	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.

PIXI.BaseTexture.removeFromCache (baseTexture)PIXI.BaseTexture | null static

BaseTexture.js:825

Remove a BaseTexture from the global BaseTextureCache.

Name	Type	Description
baseTexture	string | PIXI.BaseTexture	id of a BaseTexture to be removed, or a BaseTexture instance itself.

Returns:

Type	Description
PIXI.BaseTexture | null	The BaseTexture that was removed.

_loadSvgSource ()

BaseTexture.js:471

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)

BaseTexture.js:497

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

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

_loadSvgSourceUsingString (svgString)

BaseTexture.js:556

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:

• PIXI.BaseTexture#event:loaded

_loadSvgSourceUsingXhr ()

BaseTexture.js:520

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

_updateDimensions ()

BaseTexture.js:280

Update dimensions from real values

_updateImageType ()

BaseTexture.js:432

Updates type of the source image.

destroy ()

BaseTexture.js:614

Destroys this base texture

dispose ()

BaseTexture.js:645

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.

Fires:

• PIXI.BaseTexture#event:dispose

loadSource (source) protected

BaseTexture.js:309

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

BaseTexture.js:263

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

Fires:

• PIXI.BaseTexture#event:update

updateSourceImage (newSrc)

BaseTexture.js:656

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

dispose

BaseTexture.js:249

Fired when BaseTexture is destroyed.

Name	Type	Description
baseTexture	PIXI.BaseTexture	Instance of texture being destroyed.

error

BaseTexture.js:233

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

Name	Type	Description
baseTexture	PIXI.BaseTexture	Resource errored.

loaded

BaseTexture.js:225

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

Name	Type	Description
baseTexture	PIXI.BaseTexture	Resource loaded.

update

BaseTexture.js:241

Fired when BaseTexture is updated.

Name	Type	Description
baseTexture	PIXI.BaseTexture	Instance of texture being updated.