Name | Type | Description |
---|---|---|
baseTexture |
PIXI.BaseTexture |
The base texture source to create the texture from |
frame |
PIXI.Rectangle |
optional
The rectangle frame of the texture to show |
orig |
PIXI.Rectangle |
optional
The area of original texture |
trim |
PIXI.Rectangle |
optional
Trimmed rectangle of original texture |
rotate |
number |
optional
indicates how the texture was rotated by texture packer. See PIXI.GroupD8 |
anchor |
PIXI.Point |
optional
Default anchor point used for sprite placement / rotation |
Extends
Members
-
PIXI.Texture.EMPTY PIXI.Texture static
-
An empty texture, used often to not have to create multiple empty textures. Can not be destroyed.
-
PIXI.Texture.WHITE PIXI.Texture static
-
A white texture of 10x10 size, used for graphics and other things Can not be destroyed.
-
_frame PIXI.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)
-
Update ID is observed by sprites and TextureMatrix instances. Call updateUvs() to increment it.
-
_uvs PIXI.TextureUvs protected
-
The WebGL UV data cache. Can be used as quad UV
-
baseTexture PIXI.BaseTexture
-
The base texture that this texture uses.
-
defaultAnchor PIXI.Point
-
Anchor point that is used as default if sprite is created with this texture. Changing the
defaultAnchor
at a later point of time will not update Sprite's anchor point.- Default Value:
- {0,0}
-
frame PIXI.Rectangle
-
The frame specifies the region of the base texture that this texture uses. Please call
updateUvs()
after you change coordinates offrame
manually. -
The height of the Texture in pixels.
-
Does this Texture have any frame data assigned to it?
-
orig PIXI.Rectangle
-
This is the area of original texture, before it was put in atlas
-
This will let a renderer know that a texture has been updated (used mainly for WebGL uv updates)
-
Indicates whether the texture is rotated inside the atlas set to 2 to compensate for texture packer rotation set to 6 to compensate for spine packer rotation can be used to rotate or mirror sprites See PIXI.GroupD8 for explanation
-
The ids under which this Texture has been added to the texture cache. This is automatically set as long as Texture.addToCache is used, but may not be set if a Texture is added directly to the TextureCache array.
-
trim PIXI.Rectangle
-
This is the trimmed area of original texture, before it was put in atlas Please call
updateUvs()
after you change coordinates oftrim
manually. -
uvMatrix PIXI.TextureMatrix
-
Default TextureMatrix instance for this texture By default that object is not created because its heavy
-
This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.
-
The width of the Texture in pixels.
Methods
-
Adds a Texture to the global TextureCache. This cache is shared across the whole PIXI object.
Name Type Description texture
PIXI.Texture The Texture to add to the cache.
id
string The id that the Texture will be stored against.
-
PIXI.Texture.from (source, options)PIXI.Texture static
-
Helper function that creates a new Texture based on the source you provide. The source can be - frame id, image url, video url, canvas element, video element, base texture
Name Type Description source
number | string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | PIXI.BaseTexture Source to create texture from
options
object optional See PIXI.BaseTexture's constructor for options.
Returns:
Type Description PIXI.Texture The newly created texture -
PIXI.Texture.fromBuffer (buffer, width, height, options)PIXI.Texture static
-
Create a new Texture with a BufferResource from a Float32Array. RGBA values are floats from 0 to 1.
Name Type Description buffer
Float32Array | Uint8Array The optional array to use, if no data is provided, a new Float32Array is created.
width
number Width of the resource
height
number Height of the resource
options
object optional See PIXI.BaseTexture's constructor for options.
Returns:
Type Description PIXI.Texture The resulting new BaseTexture -
PIXI.Texture.fromCanvas ()PIXI.Texture Deprecated : since 5.0.0 static
-
- See:
Returns:
Type Description PIXI.Texture -
PIXI.Texture.fromFrame ()PIXI.Texture Deprecated : since 5.0.0 static
-
- See:
Returns:
Type Description PIXI.Texture -
PIXI.Texture.fromImage ()PIXI.Texture Deprecated : since 5.0.0 static
-
- See:
Returns:
Type Description PIXI.Texture -
PIXI.Texture.fromLoader (source, imageUrl, name)PIXI.Texture static
-
Create a texture from a source and add to the cache.
Name Type Description source
HTMLImageElement | HTMLCanvasElement The input source.
imageUrl
String File name of texture, for cache and resolving resolution.
name
String optional Human readable name for the texture cache. If no name is specified, only
imageUrl
will be used as the cache ID.Returns:
Type Description PIXI.Texture Output texture -
PIXI.Texture.fromSVG ()PIXI.Texture Deprecated : since 5.0.0 static
-
- See:
Returns:
Type Description PIXI.Texture -
PIXI.Texture.fromVideo ()PIXI.Texture Deprecated : since 5.0.0 static
-
- See:
Returns:
Type Description PIXI.Texture -
PIXI.Texture.removeFromCache (texture)PIXI.Texture | null static
-
Remove a Texture from the global TextureCache.
Name Type Description texture
string | PIXI.Texture id of a Texture to be removed, or a Texture instance itself
Returns:
Type Description PIXI.Texture | null The Texture that was removed -
clone ()PIXI.Texture
-
Creates a new texture object that acts the same as this one.
Returns:
Type Description PIXI.Texture The new texture -
Destroys this texture
Name Type Default Description destroyBase
boolean false optional Whether to destroy the base texture as well
-
Called when the base texture is updated
Name Type Description baseTexture
PIXI.BaseTexture The base texture.
-
Updates this texture on the gpu.
-
Updates the internal WebGL UV cache. Use it after you change
frame
ortrim
of the texture. Call it after changing the frame