Members

baseTexture :PIXI.BaseTexture

The base texture that this texture uses.

Source - pixi/textures/Texture.js, line 52

crop :Rectangle

This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering, irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)

Source - pixi/textures/Texture.js, line 133

frame :Rectangle

The frame specifies the region of the base texture that this texture uses

Source - pixi/textures/Texture.js, line 60

height :Number

The height of the Texture in pixels.

Source - pixi/textures/Texture.js, line 125

isTiling :Boolean

Is this a tiling texture? As used by the likes of a TilingSprite.

Source - pixi/textures/Texture.js, line 84

noFrame :Boolean

Does this Texture have any frame data assigned to it?

Source - pixi/textures/Texture.js, line 33

requiresReTint :Boolean

This will let a renderer know that a tinted parent has updated its texture.

Source - pixi/textures/Texture.js, line 100

requiresUpdate :Boolean

This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)

Source - pixi/textures/Texture.js, line 92

trim :Rectangle

The texture trim data.

Source - pixi/textures/Texture.js, line 68

valid :Boolean

This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.

Source - pixi/textures/Texture.js, line 76

width :Number

The width of the Texture in pixels.

Source - pixi/textures/Texture.js, line 117

Methods

<static> addTextureToCache(texture, id)

Adds a texture to the global PIXI.TextureCache. This cache is shared across the whole PIXI object.

Parameters:

Name	Type	Description
texture	PIXI.Texture	The Texture to add to the cache.
id	String	The id that the texture will be stored against.

Source - pixi/textures/Texture.js, line 310

<static> fromCanvas(canvas, scaleMode) → {PIXI.Texture}

Helper function that creates a new a Texture based on the given canvas element.

Parameters:

Name	Type	Description
canvas	Canvas	The canvas element source of the texture
scaleMode	Number	See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Returns:

PIXI.Texture -

Source - pixi/textures/Texture.js, line 294

<static> fromFrame(frameId) → {PIXI.Texture}

Helper function that returns a Texture objected based on the given frame id. If the frame id is not in the texture cache an error will be thrown.

Parameters:

Name	Type	Description
frameId	String	The frame id of the texture

Returns:

PIXI.Texture -

Source - pixi/textures/Texture.js, line 278

<static> fromImage(imageUrl, crossorigin, scaleMode) → {PIXI.Texture}

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

Parameters:

Name	Type	Description
imageUrl	String	The image url of the texture
crossorigin	Boolean	Whether requests should be treated as crossorigin
scaleMode	Number	See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Returns:

PIXI.Texture -

Source - pixi/textures/Texture.js, line 254

<static> removeTextureFromCache(id) → {PIXI.Texture}

Remove a texture from the global PIXI.TextureCache.

Parameters:

Name	Type	Description
id	String	The id of the texture to be removed

Returns:

PIXI.Texture -

The texture that was removed

Source - pixi/textures/Texture.js, line 323

destroy(destroyBase)

Destroys this texture

Parameters:

Name	Type	Description
destroyBase	Boolean	Whether to destroy the base texture as well

Source - pixi/textures/Texture.js, line 170

setFrame(frame)

Specifies the region of the baseTexture that this texture will use.

Parameters:

Name	Type	Description
frame	Rectangle	The frame of the texture to set it to

Source - pixi/textures/Texture.js, line 183