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 - pixi/textures/Texture.js, line 14

Members

baseTexture:PIXI.BaseTexture

The base texture that this texture uses.

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

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 127

frame:Rectangle

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

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

height:Number

The height of the Texture in pixels.

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

isTiling:Boolean

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

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

noFrame:Boolean

Does this Texture have any frame data assigned to it?

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

requiresReTint:Boolean

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

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

requiresUpdate:Boolean

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

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

rotated:Boolean

A flag that controls if this frame is rotated or not. Rotation allows you to use rotated frames in texture atlas packing, it has nothing to do with Sprite rotation.

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

trim:Rectangle

The texture trim data.

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

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 70

width:Number

The width of the Texture in pixels.

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

<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 {}PIXI.scaleModes{{/crossLink}} for possible values

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 174

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 187