Home

class: MeshSpriteRenderer


Renderer dedicated to meshes.

Methods summary


Public methods
public render(mesh: PIXI.mesh.Mesh): void
private _renderTriangleMesh(mesh: PIXI.mesh.Mesh): void
private _renderTriangles(mesh: PIXI.mesh.Mesh): void
private _renderDrawTriangle(mesh: PIXI.mesh.Mesh, index0: number, index1: number, index2: number): void
private renderMeshFlat(mesh: PIXI.mesh.Mesh): void
public destroy(): void
public render(mesh: PIXI.mesh.Mesh): void
private _renderTriangleMesh(mesh: PIXI.mesh.Mesh): void
private _renderTriangles(mesh: PIXI.mesh.Mesh): void
private _renderDrawTriangle(mesh: PIXI.mesh.Mesh, index0: number, index1: number, index2: number): void
private renderMeshFlat(mesh: PIXI.mesh.Mesh): void
public destroy(): void

Methods


render(mesh: PIXI.mesh.Mesh): void

Renders the Mesh

Params:

Name Type Attribute Description
mesh

the Mesh to render

Returns:

void


_renderTriangleMesh(mesh: PIXI.mesh.Mesh): void

Draws the object in Triangle Mesh mode

Params:

Name Type Attribute Description
mesh

the Mesh to render

Returns:

void


_renderTriangles(mesh: PIXI.mesh.Mesh): void

Draws the object in triangle mode using canvas

Params:

Name Type Attribute Description
mesh

the current mesh

Returns:

void


_renderDrawTriangle(mesh: PIXI.mesh.Mesh, index0: number, index1: number, index2: number): void

Draws one of the triangles that from the Mesh

Params:

Name Type Attribute Description
mesh

the current mesh

index0

the index of the first vertex

index1

the index of the second vertex

index2

the index of the third vertex

Returns:

void


renderMeshFlat(mesh: PIXI.mesh.Mesh): void

Renders a flat Mesh

Params:

Name Type Attribute Description
mesh

The Mesh to render

Returns:

void


destroy(): void

destroy the the renderer.

Returns:

void


render(mesh: PIXI.mesh.Mesh): void

Renders the Mesh

Params:

Name Type Attribute Description
mesh

the Mesh to render

Returns:

void


_renderTriangleMesh(mesh: PIXI.mesh.Mesh): void

Draws the object in Triangle Mesh mode

Params:

Name Type Attribute Description
mesh

the Mesh to render

Returns:

void


_renderTriangles(mesh: PIXI.mesh.Mesh): void

Draws the object in triangle mode using canvas

Params:

Name Type Attribute Description
mesh

the current mesh

Returns:

void


_renderDrawTriangle(mesh: PIXI.mesh.Mesh, index0: number, index1: number, index2: number): void

Draws one of the triangles that from the Mesh

Params:

Name Type Attribute Description
mesh

the current mesh

index0

the index of the first vertex

index1

the index of the second vertex

index2

the index of the third vertex

Returns:

void


renderMeshFlat(mesh: PIXI.mesh.Mesh): void

Renders a flat Mesh

Params:

Name Type Attribute Description
mesh

The Mesh to render

Returns:

void


destroy(): void

destroy the the renderer.

Returns:

void


  {
    "comment": "/**\n * Renderer dedicated to meshes.\n *\n * @class\n * @private\n * @memberof PIXI\n */",
    "meta": {
        "range": [
            200,
            8361
        ],
        "filename": "CanvasMeshRenderer.js",
        "lineno": 13,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas",
        "code": {
            "id": "astnode100065784",
            "name": "MeshSpriteRenderer",
            "type": "ClassDeclaration",
            "paramnames": [
                "renderer"
            ]
        }
    },
    "classdesc": "

Renderer dedicated to meshes.

", "kind": "class", "access": "private", "memberof": "PIXI", "name": "MeshSpriteRenderer", "longname": "PIXI.MeshSpriteRenderer", "scope": "static", "params": [ { "type": { "names": [ "PIXI.CanvasRenderer" ] }, "description": "

The renderer this downport works for

", "name": "renderer" } ], "___id": "T000002R006080", "___s": true, "$methods": [ { "comment": "/**\n * Renders the Mesh\n *\n * @param {PIXI.mesh.Mesh} mesh - the Mesh to render\n */", "meta": { "range": [ 508, 1571 ], "filename": "CanvasMeshRenderer.js", "lineno": 28, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100065798", "name": "MeshSpriteRenderer#render", "type": "MethodDefinition", "paramnames": [ "mesh" ] }, "vars": { "": null } }, "description": "

Renders the Mesh

", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

the Mesh to render

", "name": "mesh" } ], "name": "render", "longname": "PIXI.MeshSpriteRenderer#render", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R006083", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRendererrender", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * Draws the object in Triangle Mesh mode\n *\n * @private\n * @param {PIXI.mesh.Mesh} mesh - the Mesh to render\n */", "meta": { "range": [ 1719, 2046 ], "filename": "CanvasMeshRenderer.js", "lineno": 77, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100065939", "name": "MeshSpriteRenderer#_renderTriangleMesh", "type": "MethodDefinition", "paramnames": [ "mesh" ] }, "vars": { "": null } }, "description": "

Draws the object in Triangle Mesh mode

", "access": "private", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

the Mesh to render

", "name": "mesh" } ], "name": "_renderTriangleMesh", "longname": "PIXI.MeshSpriteRenderer#_renderTriangleMesh", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R006088", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRenderer_renderTriangleMesh", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * Draws the object in triangle mode using canvas\n *\n * @private\n * @param {PIXI.mesh.Mesh} mesh - the current mesh\n */", "meta": { "range": [ 2200, 2646 ], "filename": "CanvasMeshRenderer.js", "lineno": 97, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100065986", "name": "MeshSpriteRenderer#_renderTriangles", "type": "MethodDefinition", "paramnames": [ "mesh" ] }, "vars": { "": null } }, "description": "

Draws the object in triangle mode using canvas

", "access": "private", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

the current mesh

", "name": "mesh" } ], "name": "_renderTriangles", "longname": "PIXI.MeshSpriteRenderer#_renderTriangles", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R006092", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRenderer_renderTriangles", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * Draws one of the triangles that from the Mesh\n *\n * @private\n * @param {PIXI.mesh.Mesh} mesh - the current mesh\n * @param {number} index0 - the index of the first vertex\n * @param {number} index1 - the index of the second vertex\n * @param {number} index2 - the index of the third vertex\n */", "meta": { "range": [ 2986, 7298 ], "filename": "CanvasMeshRenderer.js", "lineno": 123, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100066052", "name": "MeshSpriteRenderer#_renderDrawTriangle", "type": "MethodDefinition", "paramnames": [ "mesh", "index0", "index1", "index2" ] }, "vars": { "": null } }, "description": "

Draws one of the triangles that from the Mesh

", "access": "private", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

the current mesh

", "name": "mesh" }, { "type": { "names": [ "number" ] }, "description": "

the index of the first vertex

", "name": "index0" }, { "type": { "names": [ "number" ] }, "description": "

the index of the second vertex

", "name": "index1" }, { "type": { "names": [ "number" ] }, "description": "

the index of the third vertex

", "name": "index2" } ], "name": "_renderDrawTriangle", "longname": "PIXI.MeshSpriteRenderer#_renderDrawTriangle", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R006100", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRenderer_renderDrawTriangle", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * Renders a flat Mesh\n *\n * @private\n * @param {PIXI.mesh.Mesh} mesh - The Mesh to render\n */", "meta": { "range": [ 7427, 8246 ], "filename": "CanvasMeshRenderer.js", "lineno": 257, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100066923", "name": "MeshSpriteRenderer#renderMeshFlat", "type": "MethodDefinition", "paramnames": [ "mesh" ] }, "vars": { "": null } }, "description": "

Renders a flat Mesh

", "access": "private", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

The Mesh to render

", "name": "mesh" } ], "name": "renderMeshFlat", "longname": "PIXI.MeshSpriteRenderer#renderMeshFlat", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R006160", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRendererrenderMeshFlat", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * destroy the the renderer.\n *\n */", "meta": { "range": [ 8308, 8359 ], "filename": "CanvasMeshRenderer.js", "lineno": 295, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100067057", "name": "MeshSpriteRenderer#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

destroy the the renderer.

", "name": "destroy", "longname": "PIXI.MeshSpriteRenderer#destroy", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "params": [], "___id": "T000002R006173", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRendererdestroy", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * Renders the Mesh\n *\n * @param {PIXI.mesh.Mesh} mesh - the Mesh to render\n */", "meta": { "range": [ 508, 1571 ], "filename": "CanvasMeshRenderer.js", "lineno": 28, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100140477", "name": "MeshSpriteRenderer#render", "type": "MethodDefinition", "paramnames": [ "mesh" ] }, "vars": { "": null } }, "description": "

Renders the Mesh

", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

the Mesh to render

", "name": "mesh" } ], "name": "render", "longname": "PIXI.MeshSpriteRenderer#render", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R013017", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRendererrender", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * Draws the object in Triangle Mesh mode\n *\n * @private\n * @param {PIXI.mesh.Mesh} mesh - the Mesh to render\n */", "meta": { "range": [ 1719, 2046 ], "filename": "CanvasMeshRenderer.js", "lineno": 77, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100140618", "name": "MeshSpriteRenderer#_renderTriangleMesh", "type": "MethodDefinition", "paramnames": [ "mesh" ] }, "vars": { "": null } }, "description": "

Draws the object in Triangle Mesh mode

", "access": "private", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

the Mesh to render

", "name": "mesh" } ], "name": "_renderTriangleMesh", "longname": "PIXI.MeshSpriteRenderer#_renderTriangleMesh", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R013022", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRenderer_renderTriangleMesh", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * Draws the object in triangle mode using canvas\n *\n * @private\n * @param {PIXI.mesh.Mesh} mesh - the current mesh\n */", "meta": { "range": [ 2200, 2646 ], "filename": "CanvasMeshRenderer.js", "lineno": 97, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100140665", "name": "MeshSpriteRenderer#_renderTriangles", "type": "MethodDefinition", "paramnames": [ "mesh" ] }, "vars": { "": null } }, "description": "

Draws the object in triangle mode using canvas

", "access": "private", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

the current mesh

", "name": "mesh" } ], "name": "_renderTriangles", "longname": "PIXI.MeshSpriteRenderer#_renderTriangles", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R013026", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRenderer_renderTriangles", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * Draws one of the triangles that from the Mesh\n *\n * @private\n * @param {PIXI.mesh.Mesh} mesh - the current mesh\n * @param {number} index0 - the index of the first vertex\n * @param {number} index1 - the index of the second vertex\n * @param {number} index2 - the index of the third vertex\n */", "meta": { "range": [ 2986, 7298 ], "filename": "CanvasMeshRenderer.js", "lineno": 123, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100140731", "name": "MeshSpriteRenderer#_renderDrawTriangle", "type": "MethodDefinition", "paramnames": [ "mesh", "index0", "index1", "index2" ] }, "vars": { "": null } }, "description": "

Draws one of the triangles that from the Mesh

", "access": "private", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

the current mesh

", "name": "mesh" }, { "type": { "names": [ "number" ] }, "description": "

the index of the first vertex

", "name": "index0" }, { "type": { "names": [ "number" ] }, "description": "

the index of the second vertex

", "name": "index1" }, { "type": { "names": [ "number" ] }, "description": "

the index of the third vertex

", "name": "index2" } ], "name": "_renderDrawTriangle", "longname": "PIXI.MeshSpriteRenderer#_renderDrawTriangle", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R013034", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRenderer_renderDrawTriangle", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * Renders a flat Mesh\n *\n * @private\n * @param {PIXI.mesh.Mesh} mesh - The Mesh to render\n */", "meta": { "range": [ 7427, 8246 ], "filename": "CanvasMeshRenderer.js", "lineno": 257, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100141602", "name": "MeshSpriteRenderer#renderMeshFlat", "type": "MethodDefinition", "paramnames": [ "mesh" ] }, "vars": { "": null } }, "description": "

Renders a flat Mesh

", "access": "private", "params": [ { "type": { "names": [ "PIXI.mesh.Mesh" ] }, "description": "

The Mesh to render

", "name": "mesh" } ], "name": "renderMeshFlat", "longname": "PIXI.MeshSpriteRenderer#renderMeshFlat", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "___id": "T000002R013094", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRendererrenderMeshFlat", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }, { "comment": "/**\n * destroy the the renderer.\n *\n */", "meta": { "range": [ 8308, 8359 ], "filename": "CanvasMeshRenderer.js", "lineno": 295, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh\\canvas", "code": { "id": "astnode100141736", "name": "MeshSpriteRenderer#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

destroy the the renderer.

", "name": "destroy", "longname": "PIXI.MeshSpriteRenderer#destroy", "kind": "function", "memberof": "PIXI.MeshSpriteRenderer", "scope": "instance", "params": [], "___id": "T000002R013107", "___s": true, "skip": true, "slug": "PIXI.MeshSpriteRendererdestroy", "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" } ], "$attributes": [], "$staticmethods": [], "$staticproperties": [], "$augments": [], "$augmentedBy": [], "filepath": "mesh\\canvas\\CanvasMeshRenderer.js" }