PixiJS

Class: TextureMatrix

PIXI.TextureMatrix

Class controls uv mapping from Texture normal space to BaseTexture normal space.

Takes trim and rotate into account. May contain clamp settings for Meshes and TilingSprite.

Can be used in Texture uvMatrix field, or separately, you can use different clamp settings on the same texture. If you want to add support for texture region of certain feature or filter, that's what you're looking for.

Takes track of Texture changes through _lastTextureID private field. Use update() method call to track it from outside.

new PIXI.TextureMatrix (texture, clampMargin)

TextureMatrix.ts:75
Name Type Attributes Description
texture PIXI.Texture

observed texture
clampMargin number <optional>

Changes frame clamping, 0.5 by default. Use -0.5 for extra border.
See:

Members

clampMargin number

Changes frame clamping Works with TilingSprite and Mesh Change to -0.5 to add a pixel to the edge, recommended for transparent trimmed textures in atlas

Default Value:
  • 0.5

clampOffset number

Changes frame clamping Works with TilingSprite and Mesh Change to 1.5 if you texture has repeated right and bottom lines, that leads to smoother borders

Default Value:
  • 0

isSimple boolean readonly

If texture size is the same as baseTexture.

Default Value:
  • false

mapCoord PIXI.Matrix readonly

Matrix operation that converts texture region coords to texture coords

texture PIXI.Texture

Texture property.

uClampFrame Float32Array readonly

Clamp region for normalized coords, left-top pixel center in xy , bottom-right in zw. Calculated based on clampOffset.

uClampOffset Float32Array readonly

Normalized clamp offset. Calculated based on clampOffset.

_textureID number protected

Tracks Texture frame changes.

_updateID number protected

Tracks Texture frame changes.

Methods

multiplyUvs (uvs, out) Float32Array

TextureMatrix.ts:106

Multiplies uvs array to transform

Name Type Attributes Default Description
uvs Float32Array

mesh uvs
out Float32Array <optional>
 uvs

output
Returns:
Type Description
Float32Array
  • output

update (forceUpdate) boolean

TextureMatrix.ts:133

Updates matrices if texture was changed.

Name Type Attributes Default Description
forceUpdate boolean <optional>
 false

if true, matrices will be updated any case
Returns:
Type Description
boolean
  • Whether or not it was updated