Discover
Learn
Get
Create
Community
Login
Navigation
These archived docs are for Phaser 2.3.0 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

PIXI. Texture

new Texture(baseTexture, frame, crop, trim)

A texture stores the information that represents an image or part of an image. It cannot be added to the display list directly. Instead use it as the texture for a PIXI.Sprite. If no frame is provided then the whole image is used.

Parameters
Name Type Argument Description
baseTexture PIXI.BaseTexture

The base texture source to create the texture from
frame Rectangle

The rectangle frame of the texture to show
crop Rectangle <optional>

The area of original texture
trim Rectangle <optional>

Trimmed texture rectangle
Source code: pixi/textures/Texture.js (Line 19)

Public Properties

baseTexture : PIXI.BaseTexture

The base texture that this texture uses.

Source code: 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 code: pixi/textures/Texture.js (Line 117)

frame :Rectangle

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

Source code: pixi/textures/Texture.js (Line 60)

height : number

The height of the Texture in pixels.

Source code: pixi/textures/Texture.js (Line 109)

noFrame : boolean

Does this Texture have any frame data assigned to it?

Source code: pixi/textures/Texture.js (Line 33)

requiresUpdate : boolean

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

Source code: pixi/textures/Texture.js (Line 84)

trim :Rectangle

The texture trim data.

Source code: 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 code: pixi/textures/Texture.js (Line 76)

width : number

The width of the Texture in pixels.

Source code: pixi/textures/Texture.js (Line 101)

Public 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 code: pixi/textures/Texture.js (Line 299)

<static> fromCanvas(canvas, scaleMode)

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

Texture

Source code: pixi/textures/Texture.js (Line 282)

<static> fromFrame(frameId)

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

Texture

Source code: pixi/textures/Texture.js (Line 266)

<static> fromImage(imageUrl, crossorigin, scaleMode)

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

Texture

Source code: pixi/textures/Texture.js (Line 242)

<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 code: pixi/textures/Texture.js (Line 312)

destroy(destroyBase)

Destroys this texture

Parameters
Name Type Description
destroyBase Boolean

Whether to destroy the base texture as well
Source code: pixi/textures/Texture.js (Line 158)

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 code: pixi/textures/Texture.js (Line 171)