class: TextureTransform

class controls uv transform and frame clamp for texture

Methods summary

Properties

Methods

texture(): void

texture property

Returns:

void

multiplyUvs(uvs: Float32Array, out: Float32Array): Float32Array

Multiplies uvs array to transform

Params:

Returns:

Float32Array

update(forceUpdate: boolean): boolean

updates matrices if texture was changed

Params:

Returns:

boolean

texture(): void

texture property

Returns:

void

multiplyUvs(uvs: Float32Array, out: Float32Array): Float32Array

Multiplies uvs array to transform

Params:

Returns:

Float32Array

update(forceUpdate: boolean): boolean

updates matrices if texture was changed

Params:

Returns:

boolean

  {
    "comment": "/**\n * class controls uv transform and frame clamp for texture\n *\n * @class\n * @memberof PIXI.extras\n */",
    "meta": {
        "range": [
            228,
            3925
        ],
        "filename": "TextureTransform.js",
        "lineno": 13,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
        "code": {
            "id": "astnode100054759",
            "name": "TextureTransform",
            "type": "ClassDeclaration",
            "paramnames": [
                "texture",
                "clampMargin"
            ]
        }
    },
    "classdesc": "
class controls uv transform and frame clamp for texture
",
    "kind": "class",
    "memberof": "PIXI.extras",
    "name": "TextureTransform",
    "longname": "PIXI.extras.TextureTransform",
    "scope": "static",
    "params": [
        {
            "type": {
                "names": [
                    "PIXI.Texture"
                ]
            },
            "description": "
observed texture
",
            "name": "texture"
        },
        {
            "type": {
                "names": [
                    "number"
                ]
            },
            "optional": true,
            "description": "
Changes frame clamping, 0.5 by default. Use -0.5 for extra border.
",
            "name": "clampMargin"
        }
    ],
    "___id": "T000002R005180",
    "___s": true,
    "$methods": [
        {
            "comment": "/**\n     * texture property\n     * @member {PIXI.Texture}\n     */",
            "meta": {
                "range": [
                    1528,
                    1583
                ],
                "filename": "TextureTransform.js",
                "lineno": 58,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {
                    "id": "astnode100054822",
                    "name": "TextureTransform#texture",
                    "type": "MethodDefinition",
                    "paramnames": []
                },
                "vars": {
                    "": null
                }
            },
            "description": "
texture property
",
            "kind": "member",
            "type": {
                "names": [
                    "PIXI.Texture"
                ]
            },
            "name": "texture",
            "longname": "PIXI.extras.TextureTransform#texture",
            "memberof": "PIXI.extras.TextureTransform",
            "scope": "instance",
            "params": [],
            "___id": "T000002R005191",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformtexture",
            "filepath": "extras\\TextureTransform.js"
        },
        {
            "comment": "/**\n     * Multiplies uvs array to transform\n     * @param {Float32Array} uvs mesh uvs\n     * @param {Float32Array} [out=uvs] output\n     * @returns {Float32Array} output\n     */",
            "meta": {
                "range": [
                    1910,
                    2326
                ],
                "filename": "TextureTransform.js",
                "lineno": 75,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {
                    "id": "astnode100054848",
                    "name": "TextureTransform#multiplyUvs",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "uvs",
                        "out"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Multiplies uvs array to transform
",
            "params": [
                {
                    "type": {
                        "names": [
                            "Float32Array"
                        ]
                    },
                    "description": "
mesh uvs
",
                    "name": "uvs"
                },
                {
                    "type": {
                        "names": [
                            "Float32Array"
                        ]
                    },
                    "optional": true,
                    "defaultvalue": "uvs",
                    "description": "
output
",
                    "name": "out"
                }
            ],
            "returns": [
                {
                    "type": {
                        "names": [
                            "Float32Array"
                        ]
                    },
                    "description": "
output
"
                }
            ],
            "name": "multiplyUvs",
            "longname": "PIXI.extras.TextureTransform#multiplyUvs",
            "kind": "function",
            "memberof": "PIXI.extras.TextureTransform",
            "scope": "instance",
            "___id": "T000002R005195",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformmultiplyUvs",
            "filepath": "extras\\TextureTransform.js"
        },
        {
            "comment": "/**\n     * updates matrices if texture was changed\n     * @param {boolean} forceUpdate if true, matrices will be updated any case\n     * @returns {boolean} whether or not it was updated\n     */",
            "meta": {
                "range": [
                    2530,
                    3923
                ],
                "filename": "TextureTransform.js",
                "lineno": 101,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {
                    "id": "astnode100054941",
                    "name": "TextureTransform#update",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "forceUpdate"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
updates matrices if texture was changed
",
            "params": [
                {
                    "type": {
                        "names": [
                            "boolean"
                        ]
                    },
                    "description": "
if true, matrices will be updated any case
",
                    "name": "forceUpdate"
                }
            ],
            "returns": [
                {
                    "type": {
                        "names": [
                            "boolean"
                        ]
                    },
                    "description": "
whether or not it was updated
"
                }
            ],
            "name": "update",
            "longname": "PIXI.extras.TextureTransform#update",
            "kind": "function",
            "memberof": "PIXI.extras.TextureTransform",
            "scope": "instance",
            "___id": "T000002R005204",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformupdate",
            "filepath": "extras\\TextureTransform.js"
        },
        {
            "comment": "/**\n     * texture property\n     * @member {PIXI.Texture}\n     */",
            "meta": {
                "range": [
                    1528,
                    1583
                ],
                "filename": "TextureTransform.js",
                "lineno": 58,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {
                    "id": "astnode100129501",
                    "name": "TextureTransform#texture",
                    "type": "MethodDefinition",
                    "paramnames": []
                },
                "vars": {
                    "": null
                }
            },
            "description": "
texture property
",
            "kind": "member",
            "type": {
                "names": [
                    "PIXI.Texture"
                ]
            },
            "name": "texture",
            "longname": "PIXI.extras.TextureTransform#texture",
            "memberof": "PIXI.extras.TextureTransform",
            "scope": "instance",
            "params": [],
            "___id": "T000002R012125",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformtexture",
            "filepath": "extras\\TextureTransform.js"
        },
        {
            "comment": "/**\n     * Multiplies uvs array to transform\n     * @param {Float32Array} uvs mesh uvs\n     * @param {Float32Array} [out=uvs] output\n     * @returns {Float32Array} output\n     */",
            "meta": {
                "range": [
                    1910,
                    2326
                ],
                "filename": "TextureTransform.js",
                "lineno": 75,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {
                    "id": "astnode100129527",
                    "name": "TextureTransform#multiplyUvs",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "uvs",
                        "out"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Multiplies uvs array to transform
",
            "params": [
                {
                    "type": {
                        "names": [
                            "Float32Array"
                        ]
                    },
                    "description": "
mesh uvs
",
                    "name": "uvs"
                },
                {
                    "type": {
                        "names": [
                            "Float32Array"
                        ]
                    },
                    "optional": true,
                    "defaultvalue": "uvs",
                    "description": "
output
",
                    "name": "out"
                }
            ],
            "returns": [
                {
                    "type": {
                        "names": [
                            "Float32Array"
                        ]
                    },
                    "description": "
output
"
                }
            ],
            "name": "multiplyUvs",
            "longname": "PIXI.extras.TextureTransform#multiplyUvs",
            "kind": "function",
            "memberof": "PIXI.extras.TextureTransform",
            "scope": "instance",
            "___id": "T000002R012129",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformmultiplyUvs",
            "filepath": "extras\\TextureTransform.js"
        },
        {
            "comment": "/**\n     * updates matrices if texture was changed\n     * @param {boolean} forceUpdate if true, matrices will be updated any case\n     * @returns {boolean} whether or not it was updated\n     */",
            "meta": {
                "range": [
                    2530,
                    3923
                ],
                "filename": "TextureTransform.js",
                "lineno": 101,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {
                    "id": "astnode100129620",
                    "name": "TextureTransform#update",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "forceUpdate"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
updates matrices if texture was changed
",
            "params": [
                {
                    "type": {
                        "names": [
                            "boolean"
                        ]
                    },
                    "description": "
if true, matrices will be updated any case
",
                    "name": "forceUpdate"
                }
            ],
            "returns": [
                {
                    "type": {
                        "names": [
                            "boolean"
                        ]
                    },
                    "description": "
whether or not it was updated
"
                }
            ],
            "name": "update",
            "longname": "PIXI.extras.TextureTransform#update",
            "kind": "function",
            "memberof": "PIXI.extras.TextureTransform",
            "scope": "instance",
            "___id": "T000002R012138",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformupdate",
            "filepath": "extras\\TextureTransform.js"
        }
    ],
    "$attributes": [
        {
            "comment": "/**\n         * Changes frame clamping\n         * Works with TilingSprite and Mesh\n         * Change to 1.5 if you texture has repeated right and bottom lines, that leads to smoother borders\n         *\n         * @default 0\n         * @member {number} PIXI.extras.TextureTransform#clampOffset\n         */",
            "meta": {
                "range": [
                    713,
                    1016
                ],
                "filename": "TextureTransform.js",
                "lineno": 33,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {}
            },
            "description": "
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
",
            "defaultvalue": "0",
            "kind": "member",
            "name": "clampOffset",
            "type": {
                "names": [
                    "number"
                ]
            },
            "memberof": "PIXI.extras.TextureTransform",
            "longname": "PIXI.extras.TextureTransform#clampOffset",
            "scope": "instance",
            "___id": "T000002R005187",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformclampOffset",
            "filepath": "extras\\TextureTransform.js"
        },
        {
            "comment": "/**\n         * Changes frame clamping\n         * Works with TilingSprite and Mesh\n         * Change to -0.5 to add a pixel to the edge, recommended for transparent trimmed textures in atlas\n         *\n         * @default 0.5\n         * @member {number} PIXI.extras.TextureTransform#clampMargin\n         */",
            "meta": {
                "range": [
                    1056,
                    1361
                ],
                "filename": "TextureTransform.js",
                "lineno": 43,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {}
            },
            "description": "
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
",
            "defaultvalue": "0.5",
            "kind": "member",
            "name": "clampMargin",
            "type": {
                "names": [
                    "number"
                ]
            },
            "memberof": "PIXI.extras.TextureTransform",
            "longname": "PIXI.extras.TextureTransform#clampMargin",
            "scope": "instance",
            "___id": "T000002R005189",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformclampMargin",
            "filepath": "extras\\TextureTransform.js"
        },
        {
            "comment": "/**\n         * Changes frame clamping\n         * Works with TilingSprite and Mesh\n         * Change to 1.5 if you texture has repeated right and bottom lines, that leads to smoother borders\n         *\n         * @default 0\n         * @member {number} PIXI.extras.TextureTransform#clampOffset\n         */",
            "meta": {
                "range": [
                    713,
                    1016
                ],
                "filename": "TextureTransform.js",
                "lineno": 33,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {}
            },
            "description": "
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
",
            "defaultvalue": "0",
            "kind": "member",
            "name": "clampOffset",
            "type": {
                "names": [
                    "number"
                ]
            },
            "memberof": "PIXI.extras.TextureTransform",
            "longname": "PIXI.extras.TextureTransform#clampOffset",
            "scope": "instance",
            "___id": "T000002R012121",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformclampOffset",
            "filepath": "extras\\TextureTransform.js"
        },
        {
            "comment": "/**\n         * Changes frame clamping\n         * Works with TilingSprite and Mesh\n         * Change to -0.5 to add a pixel to the edge, recommended for transparent trimmed textures in atlas\n         *\n         * @default 0.5\n         * @member {number} PIXI.extras.TextureTransform#clampMargin\n         */",
            "meta": {
                "range": [
                    1056,
                    1361
                ],
                "filename": "TextureTransform.js",
                "lineno": 43,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras",
                "code": {}
            },
            "description": "
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
",
            "defaultvalue": "0.5",
            "kind": "member",
            "name": "clampMargin",
            "type": {
                "names": [
                    "number"
                ]
            },
            "memberof": "PIXI.extras.TextureTransform",
            "longname": "PIXI.extras.TextureTransform#clampMargin",
            "scope": "instance",
            "___id": "T000002R012123",
            "___s": true,
            "skip": true,
            "slug": "PIXI.extras.TextureTransformclampMargin",
            "filepath": "extras\\TextureTransform.js"
        }
    ],
    "$staticmethods": [],
    "$staticproperties": [],
    "$augments": [],
    "$augmentedBy": [],
    "filepath": "extras\\TextureTransform.js"
}