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 14)
Public Properties
-
baseTexture : PIXI.BaseTexture
-
The base texture that this texture uses.
- Source code: pixi/textures/Texture.js (Line 47)
-
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 128)
-
frame :Rectangle
-
The frame specifies the region of the base texture that this texture uses
- Source code: pixi/textures/Texture.js (Line 55)
-
height : number
-
The height of the Texture in pixels.
- Source code: pixi/textures/Texture.js (Line 120)
-
isTiling : boolean
-
Is this a tiling texture? As used by the likes of a TilingSprite.
- Source code: pixi/textures/Texture.js (Line 79)
-
noFrame : boolean
-
Does this Texture have any frame data assigned to it?
- Source code: pixi/textures/Texture.js (Line 28)
-
requiresReTint : boolean
-
This will let a renderer know that a tinted parent has updated its texture.
- Source code: pixi/textures/Texture.js (Line 95)
-
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 87)
-
trim :Rectangle
-
The texture trim data.
- Source code: pixi/textures/Texture.js (Line 63)
-
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 71)
-
width : number
-
The width of the Texture in pixels.
- Source code: pixi/textures/Texture.js (Line 112)
Public Methods
-
<static> fromCanvas(canvas, scaleMode) → {PIXI.Texture}
-
Helper function that creates a new a Texture based on the given canvas element.
Parameters
Name Type Description canvasCanvas The canvas element source of the texture
scaleModeNumber See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values
Returns
- Source code: pixi/textures/Texture.js (Line 249)
-
destroy(destroyBase)
-
Destroys this texture
Parameters
Name Type Description destroyBaseBoolean Whether to destroy the base texture as well
- Source code: pixi/textures/Texture.js (Line 165)
-
setFrame(frame)
-
Specifies the region of the baseTexture that this texture will use.
Parameters
Name Type Description frameRectangle The frame of the texture to set it to
- Source code: pixi/textures/Texture.js (Line 178)