Home

class: SpriteRenderer


Renderer dedicated to drawing and batching sprites.

Extends:

WebGLManagerObjectRenderer → SpriteRenderer

Methods summary


Public methods
private onContextChange(): void
public onPrerender(): void
public render(sprite: PIXI.Sprite): void
public flush(): void
public start(): void
public stop(): void
public destroy(): void
private onContextChange(): void
public onPrerender(): void
public render(sprite: PIXI.Sprite): void
public flush(): void
public start(): void
public stop(): void
public destroy(): void

Properties


Name Type Attribute Description
vertSize number public

Number of values sent in the vertex buffer.
aVertexPosition(2), aTextureCoord(1), aColor(1), aTextureId(1) = 5

vertByteSize number public

The size of the vertex information in bytes.

size number public

The number of images in the SpriteRenderer before it flushes.

indices Uint16Array public

Holds the indices of the geometry (quads) to draw

shader Array. public

The default shaders that is used if a sprite doesn't have a more specific one.
there is a shader for each number of textures that can be rendererd.
These shaders will also be generated on the fly as required.

vertSize number public

Number of values sent in the vertex buffer.
aVertexPosition(2), aTextureCoord(1), aColor(1), aTextureId(1) = 5

vertByteSize number public

The size of the vertex information in bytes.

size number public

The number of images in the SpriteRenderer before it flushes.

indices Uint16Array public

Holds the indices of the geometry (quads) to draw

shader Array. public

The default shaders that is used if a sprite doesn't have a more specific one.
there is a shader for each number of textures that can be rendererd.
These shaders will also be generated on the fly as required.

renderer PIXI.WebGLRenderer public

The renderer this manager works for.

Methods


onContextChange(): void

Sets up the renderer context and necessary buffers.

Returns:

void


onPrerender(): void

Called before the renderer starts rendering.

Returns:

void


render(sprite: PIXI.Sprite): void

Renders the sprite object.

Params:

Name Type Attribute Description
sprite

the sprite to render when using this spritebatch

Returns:

void


flush(): void

Renders the content and empties the current batch.

Returns:

void


start(): void

Starts a new sprite batch.

Returns:

void


stop(): void

Stops and flushes the current batch.

Returns:

void


destroy(): void

Destroys the SpriteRenderer.

Returns:

void


onContextChange(): void

Sets up the renderer context and necessary buffers.

Returns:

void


onPrerender(): void

Called before the renderer starts rendering.

Returns:

void


render(sprite: PIXI.Sprite): void

Renders the sprite object.

Params:

Name Type Attribute Description
sprite

the sprite to render when using this spritebatch

Returns:

void


flush(): void

Renders the content and empties the current batch.

Returns:

void


start(): void

Starts a new sprite batch.

Returns:

void


stop(): void

Stops and flushes the current batch.

Returns:

void


destroy(): void

Destroys the SpriteRenderer.

Returns:

void


  {
    "comment": "/**\n * Renderer dedicated to drawing and batching sprites.\n *\n * @class\n * @private\n * @memberof PIXI\n * @extends PIXI.ObjectRenderer\n */",
    "meta": {
        "range": [
            735,
            16203
        ],
        "filename": "SpriteRenderer.js",
        "lineno": 24,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl",
        "code": {
            "id": "astnode100035480",
            "name": "SpriteRenderer",
            "type": "ClassDeclaration",
            "paramnames": [
                "renderer"
            ]
        }
    },
    "classdesc": "

Renderer dedicated to drawing and batching sprites.

", "kind": "class", "access": "private", "memberof": "PIXI", "augments": [ "PIXI.ObjectRenderer" ], "name": "SpriteRenderer", "longname": "PIXI.SpriteRenderer", "scope": "static", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "

The renderer this sprite batch works for.

", "name": "renderer" } ], "___id": "T000002R003244", "___s": true, "$methods": [ { "comment": "/**\n * Sets up the renderer context and necessary buffers.\n *\n * @private\n */", "meta": { "range": [ 3067, 5161 ], "filename": "SpriteRenderer.js", "lineno": 103, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100035660", "name": "SpriteRenderer#onContextChange", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Sets up the renderer context and necessary buffers.

", "access": "private", "name": "onContextChange", "longname": "PIXI.SpriteRenderer#onContextChange", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#onContextChange", "___id": "T000002R003274", "___s": true, "skip": true, "slug": "PIXI.SpriteRendereronContextChange", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Called before the renderer starts rendering.\n *\n */", "meta": { "range": [ 5242, 5297 ], "filename": "SpriteRenderer.js", "lineno": 163, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100035916", "name": "SpriteRenderer#onPrerender", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Called before the renderer starts rendering.

", "name": "onPrerender", "longname": "PIXI.SpriteRenderer#onPrerender", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "___id": "T000002R003290", "___s": true, "skip": true, "slug": "PIXI.SpriteRendereronPrerender", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Renders the sprite object.\n *\n * @param {PIXI.Sprite} sprite - the sprite to render when using this spritebatch\n */", "meta": { "range": [ 5446, 5927 ], "filename": "SpriteRenderer.js", "lineno": 173, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100035926", "name": "SpriteRenderer#render", "type": "MethodDefinition", "paramnames": [ "sprite" ] }, "vars": { "": null } }, "description": "

Renders the sprite object.

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

the sprite to render when using this spritebatch

", "name": "sprite" } ], "name": "render", "longname": "PIXI.SpriteRenderer#render", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "overrides": "PIXI.ObjectRenderer#render", "___id": "T000002R003292", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererrender", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Renders the content and empties the current batch.\n *\n */", "meta": { "range": [ 6014, 14797 ], "filename": "SpriteRenderer.js", "lineno": 199, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100035965", "name": "SpriteRenderer#flush", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Renders the content and empties the current batch.

", "name": "flush", "longname": "PIXI.SpriteRenderer#flush", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#flush", "___id": "T000002R003294", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererflush", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Starts a new sprite batch.\n */", "meta": { "range": [ 14853, 15159 ], "filename": "SpriteRenderer.js", "lineno": 459, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100037057", "name": "SpriteRenderer#start", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Starts a new sprite batch.

", "name": "start", "longname": "PIXI.SpriteRenderer#start", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#start", "___id": "T000002R003393", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererstart", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Stops and flushes the current batch.\n *\n */", "meta": { "range": [ 15232, 15272 ], "filename": "SpriteRenderer.js", "lineno": 476, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100037101", "name": "SpriteRenderer#stop", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Stops and flushes the current batch.

", "name": "stop", "longname": "PIXI.SpriteRenderer#stop", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#stop", "___id": "T000002R003394", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererstop", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Destroys the SpriteRenderer.\n *\n */", "meta": { "range": [ 15337, 16201 ], "filename": "SpriteRenderer.js", "lineno": 485, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100037110", "name": "SpriteRenderer#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the SpriteRenderer.

", "name": "destroy", "longname": "PIXI.SpriteRenderer#destroy", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#destroy", "___id": "T000002R003395", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererdestroy", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Sets up the renderer context and necessary buffers.\n *\n * @private\n */", "meta": { "range": [ 3067, 5161 ], "filename": "SpriteRenderer.js", "lineno": 103, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100110339", "name": "SpriteRenderer#onContextChange", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Sets up the renderer context and necessary buffers.

", "access": "private", "name": "onContextChange", "longname": "PIXI.SpriteRenderer#onContextChange", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#onContextChange", "___id": "T000002R010208", "___s": true, "skip": true, "slug": "PIXI.SpriteRendereronContextChange", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Called before the renderer starts rendering.\n *\n */", "meta": { "range": [ 5242, 5297 ], "filename": "SpriteRenderer.js", "lineno": 163, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100110595", "name": "SpriteRenderer#onPrerender", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Called before the renderer starts rendering.

", "name": "onPrerender", "longname": "PIXI.SpriteRenderer#onPrerender", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "___id": "T000002R010224", "___s": true, "skip": true, "slug": "PIXI.SpriteRendereronPrerender", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Renders the sprite object.\n *\n * @param {PIXI.Sprite} sprite - the sprite to render when using this spritebatch\n */", "meta": { "range": [ 5446, 5927 ], "filename": "SpriteRenderer.js", "lineno": 173, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100110605", "name": "SpriteRenderer#render", "type": "MethodDefinition", "paramnames": [ "sprite" ] }, "vars": { "": null } }, "description": "

Renders the sprite object.

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

the sprite to render when using this spritebatch

", "name": "sprite" } ], "name": "render", "longname": "PIXI.SpriteRenderer#render", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "overrides": "PIXI.ObjectRenderer#render", "___id": "T000002R010226", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererrender", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Renders the content and empties the current batch.\n *\n */", "meta": { "range": [ 6014, 14797 ], "filename": "SpriteRenderer.js", "lineno": 199, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100110644", "name": "SpriteRenderer#flush", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Renders the content and empties the current batch.

", "name": "flush", "longname": "PIXI.SpriteRenderer#flush", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#flush", "___id": "T000002R010228", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererflush", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Starts a new sprite batch.\n */", "meta": { "range": [ 14853, 15159 ], "filename": "SpriteRenderer.js", "lineno": 459, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100111736", "name": "SpriteRenderer#start", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Starts a new sprite batch.

", "name": "start", "longname": "PIXI.SpriteRenderer#start", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#start", "___id": "T000002R010327", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererstart", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Stops and flushes the current batch.\n *\n */", "meta": { "range": [ 15232, 15272 ], "filename": "SpriteRenderer.js", "lineno": 476, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100111780", "name": "SpriteRenderer#stop", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Stops and flushes the current batch.

", "name": "stop", "longname": "PIXI.SpriteRenderer#stop", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#stop", "___id": "T000002R010328", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererstop", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Destroys the SpriteRenderer.\n *\n */", "meta": { "range": [ 15337, 16201 ], "filename": "SpriteRenderer.js", "lineno": 485, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": { "id": "astnode100111789", "name": "SpriteRenderer#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the SpriteRenderer.

", "name": "destroy", "longname": "PIXI.SpriteRenderer#destroy", "kind": "function", "memberof": "PIXI.SpriteRenderer", "scope": "instance", "params": [], "overrides": "PIXI.ObjectRenderer#destroy", "___id": "T000002R010329", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererdestroy", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" } ], "$attributes": [ { "comment": "/**\n * Number of values sent in the vertex buffer.\n * aVertexPosition(2), aTextureCoord(1), aColor(1), aTextureId(1) = 5\n *\n * @member {number} PIXI.SpriteRenderer#vertSize\n */", "meta": { "range": [ 951, 1167 ], "filename": "SpriteRenderer.js", "lineno": 33, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

Number of values sent in the vertex buffer.
aVertexPosition(2), aTextureCoord(1), aColor(1), aTextureId(1) = 5

", "kind": "member", "name": "vertSize", "type": { "names": [ "number" ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#vertSize", "scope": "instance", "___id": "T000002R003246", "___s": true, "skip": true, "slug": "PIXI.SpriteRenderervertSize", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * The size of the vertex information in bytes.\n *\n * @member {number} PIXI.SpriteRenderer#vertByteSize\n */", "meta": { "range": [ 1204, 1347 ], "filename": "SpriteRenderer.js", "lineno": 41, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

The size of the vertex information in bytes.

", "kind": "member", "name": "vertByteSize", "type": { "names": [ "number" ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#vertByteSize", "scope": "instance", "___id": "T000002R003248", "___s": true, "skip": true, "slug": "PIXI.SpriteRenderervertByteSize", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * The number of images in the SpriteRenderer before it flushes.\n *\n * @member {number} PIXI.SpriteRenderer#size\n */", "meta": { "range": [ 1404, 1556 ], "filename": "SpriteRenderer.js", "lineno": 48, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

The number of images in the SpriteRenderer before it flushes.

", "kind": "member", "name": "size", "type": { "names": [ "number" ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#size", "scope": "instance", "___id": "T000002R003250", "___s": true, "skip": true, "slug": "PIXI.SpriteRenderersize", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Holds the indices of the geometry (quads) to draw\n *\n * @member {Uint16Array} PIXI.SpriteRenderer#indices\n */", "meta": { "range": [ 1964, 2112 ], "filename": "SpriteRenderer.js", "lineno": 64, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

Holds the indices of the geometry (quads) to draw

", "kind": "member", "name": "indices", "type": { "names": [ "Uint16Array" ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#indices", "scope": "instance", "___id": "T000002R003255", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererindices", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * The default shaders that is used if a sprite doesn't have a more specific one.\n * there is a shader for each number of textures that can be rendererd.\n * These shaders will also be generated on the fly as required.\n * @member {PIXI.Shader[]} PIXI.SpriteRenderer#shader\n */", "meta": { "range": [ 2179, 2498 ], "filename": "SpriteRenderer.js", "lineno": 71, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

The default shaders that is used if a sprite doesn't have a more specific one.
there is a shader for each number of textures that can be rendererd.
These shaders will also be generated on the fly as required.

", "kind": "member", "name": "shader", "type": { "names": [ "Array." ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#shader", "scope": "instance", "___id": "T000002R003257", "___s": true, "skip": true, "slug": "PIXI.SpriteRenderershader", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Number of values sent in the vertex buffer.\n * aVertexPosition(2), aTextureCoord(1), aColor(1), aTextureId(1) = 5\n *\n * @member {number} PIXI.SpriteRenderer#vertSize\n */", "meta": { "range": [ 951, 1167 ], "filename": "SpriteRenderer.js", "lineno": 33, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

Number of values sent in the vertex buffer.
aVertexPosition(2), aTextureCoord(1), aColor(1), aTextureId(1) = 5

", "kind": "member", "name": "vertSize", "type": { "names": [ "number" ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#vertSize", "scope": "instance", "___id": "T000002R010180", "___s": true, "skip": true, "slug": "PIXI.SpriteRenderervertSize", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * The size of the vertex information in bytes.\n *\n * @member {number} PIXI.SpriteRenderer#vertByteSize\n */", "meta": { "range": [ 1204, 1347 ], "filename": "SpriteRenderer.js", "lineno": 41, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

The size of the vertex information in bytes.

", "kind": "member", "name": "vertByteSize", "type": { "names": [ "number" ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#vertByteSize", "scope": "instance", "___id": "T000002R010182", "___s": true, "skip": true, "slug": "PIXI.SpriteRenderervertByteSize", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * The number of images in the SpriteRenderer before it flushes.\n *\n * @member {number} PIXI.SpriteRenderer#size\n */", "meta": { "range": [ 1404, 1556 ], "filename": "SpriteRenderer.js", "lineno": 48, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

The number of images in the SpriteRenderer before it flushes.

", "kind": "member", "name": "size", "type": { "names": [ "number" ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#size", "scope": "instance", "___id": "T000002R010184", "___s": true, "skip": true, "slug": "PIXI.SpriteRenderersize", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * Holds the indices of the geometry (quads) to draw\n *\n * @member {Uint16Array} PIXI.SpriteRenderer#indices\n */", "meta": { "range": [ 1964, 2112 ], "filename": "SpriteRenderer.js", "lineno": 64, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

Holds the indices of the geometry (quads) to draw

", "kind": "member", "name": "indices", "type": { "names": [ "Uint16Array" ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#indices", "scope": "instance", "___id": "T000002R010189", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererindices", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * The default shaders that is used if a sprite doesn't have a more specific one.\n * there is a shader for each number of textures that can be rendererd.\n * These shaders will also be generated on the fly as required.\n * @member {PIXI.Shader[]} PIXI.SpriteRenderer#shader\n */", "meta": { "range": [ 2179, 2498 ], "filename": "SpriteRenderer.js", "lineno": 71, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\webgl", "code": {} }, "description": "

The default shaders that is used if a sprite doesn't have a more specific one.
there is a shader for each number of textures that can be rendererd.
These shaders will also be generated on the fly as required.

", "kind": "member", "name": "shader", "type": { "names": [ "Array." ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#shader", "scope": "instance", "___id": "T000002R010191", "___s": true, "skip": true, "slug": "PIXI.SpriteRenderershader", "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }, { "comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */", "meta": { "range": [ 226, 367 ], "filename": "WebGLManager.js", "lineno": 14, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": {} }, "description": "

The renderer this manager works for.

", "kind": "member", "name": "renderer", "type": { "names": [ "PIXI.WebGLRenderer" ] }, "memberof": "PIXI.SpriteRenderer", "longname": "PIXI.SpriteRenderer#renderer", "scope": "instance", "inherits": "PIXI.WebGLManager#renderer", "inherited": true, "overrides": "PIXI.ObjectRenderer#renderer", "___id": "T000002R014065", "___s": true, "skip": true, "slug": "PIXI.SpriteRendererrenderer", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [ { "comment": "/**\n * Base for a common object renderer that can be used as a system renderer plugin.\n *\n * @class\n * @extends PIXI.WebGLManager\n * @memberof PIXI\n */", "meta": { "range": [ 238, 852 ], "filename": "ObjectRenderer.js", "lineno": 12, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100028384", "name": "ObjectRenderer", "type": "ClassDeclaration", "paramnames": [] } }, "classdesc": "

Base for a common object renderer that can be used as a system renderer plugin.

", "kind": "class", "augments": [ "PIXI.WebGLManager" ], "memberof": "PIXI", "name": "ObjectRenderer", "longname": "PIXI.ObjectRenderer", "scope": "static", "___id": "T000002R002604", "___s": true, "$methods": [ { "comment": "/**\n * Starts the renderer and sets the shader\n *\n */", "meta": { "range": [ 356, 403 ], "filename": "ObjectRenderer.js", "lineno": 18, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100028388", "name": "ObjectRenderer#start", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Starts the renderer and sets the shader

", "name": "start", "longname": "PIXI.ObjectRenderer#start", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "params": [], "___id": "T000002R002605", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererstart", "filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js" }, { "comment": "/**\n * Stops the renderer\n *\n */", "meta": { "range": [ 458, 498 ], "filename": "ObjectRenderer.js", "lineno": 27, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100028392", "name": "ObjectRenderer#stop", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Stops the renderer

", "name": "stop", "longname": "PIXI.ObjectRenderer#stop", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "params": [], "___id": "T000002R002606", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererstop", "filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js" }, { "comment": "/**\n * Stub method for rendering content and emptying the current batch.\n *\n */", "meta": { "range": [ 600, 637 ], "filename": "ObjectRenderer.js", "lineno": 36, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100028401", "name": "ObjectRenderer#flush", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Stub method for rendering content and emptying the current batch.

", "name": "flush", "longname": "PIXI.ObjectRenderer#flush", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "params": [], "___id": "T000002R002607", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererflush", "filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js" }, { "comment": "/**\n * Renders an object\n *\n * @param {PIXI.DisplayObject} object - The object to render.\n */", "meta": { "range": [ 757, 850 ], "filename": "ObjectRenderer.js", "lineno": 46, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100028405", "name": "ObjectRenderer#render", "type": "MethodDefinition", "paramnames": [ "object" ] }, "vars": { "": null } }, "description": "

Renders an object

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

The object to render.

", "name": "object" } ], "name": "render", "longname": "PIXI.ObjectRenderer#render", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "___id": "T000002R002608", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererrender", "filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js" }, { "comment": "/**\n * Starts the renderer and sets the shader\n *\n */", "meta": { "range": [ 356, 403 ], "filename": "ObjectRenderer.js", "lineno": 18, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100103067", "name": "ObjectRenderer#start", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Starts the renderer and sets the shader

", "name": "start", "longname": "PIXI.ObjectRenderer#start", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "params": [], "___id": "T000002R009539", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererstart", "filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js" }, { "comment": "/**\n * Stops the renderer\n *\n */", "meta": { "range": [ 458, 498 ], "filename": "ObjectRenderer.js", "lineno": 27, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100103071", "name": "ObjectRenderer#stop", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Stops the renderer

", "name": "stop", "longname": "PIXI.ObjectRenderer#stop", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "params": [], "___id": "T000002R009540", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererstop", "filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js" }, { "comment": "/**\n * Stub method for rendering content and emptying the current batch.\n *\n */", "meta": { "range": [ 600, 637 ], "filename": "ObjectRenderer.js", "lineno": 36, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100103080", "name": "ObjectRenderer#flush", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Stub method for rendering content and emptying the current batch.

", "name": "flush", "longname": "PIXI.ObjectRenderer#flush", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "params": [], "___id": "T000002R009541", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererflush", "filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js" }, { "comment": "/**\n * Renders an object\n *\n * @param {PIXI.DisplayObject} object - The object to render.\n */", "meta": { "range": [ 757, 850 ], "filename": "ObjectRenderer.js", "lineno": 46, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\utils", "code": { "id": "astnode100103084", "name": "ObjectRenderer#render", "type": "MethodDefinition", "paramnames": [ "object" ] }, "vars": { "": null } }, "description": "

Renders an object

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

The object to render.

", "name": "object" } ], "name": "render", "longname": "PIXI.ObjectRenderer#render", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "___id": "T000002R009542", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererrender", "filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js" }, { "comment": "/**\n * Generic method called when there is a WebGL context change.\n *\n */", "meta": { "range": [ 569, 629 ], "filename": "WebGLManager.js", "lineno": 28, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": { "id": "astnode100026924", "name": "WebGLManager#onContextChange", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Generic method called when there is a WebGL context change.

", "name": "onContextChange", "longname": "PIXI.ObjectRenderer#onContextChange", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "params": [], "inherits": "PIXI.WebGLManager#onContextChange", "inherited": true, "overrides": "PIXI.WebGLManager#onContextChange", "___id": "T000002R013957", "___s": true, "skip": true, "slug": "PIXI.ObjectRendereronContextChange", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" }, { "comment": "/**\n * Generic destroy methods to be overridden by the subclass\n *\n */", "meta": { "range": [ 722, 840 ], "filename": "WebGLManager.js", "lineno": 37, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": { "id": "astnode100026928", "name": "WebGLManager#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Generic destroy methods to be overridden by the subclass

", "name": "destroy", "longname": "PIXI.ObjectRenderer#destroy", "kind": "function", "memberof": "PIXI.ObjectRenderer", "scope": "instance", "params": [], "inherits": "PIXI.WebGLManager#destroy", "inherited": true, "overrides": "PIXI.WebGLManager#destroy", "___id": "T000002R013958", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererdestroy", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" } ], "$attributes": [ { "comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */", "meta": { "range": [ 226, 367 ], "filename": "WebGLManager.js", "lineno": 14, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": {} }, "description": "

The renderer this manager works for.

", "kind": "member", "name": "renderer", "type": { "names": [ "PIXI.WebGLRenderer" ] }, "memberof": "PIXI.ObjectRenderer", "longname": "PIXI.ObjectRenderer#renderer", "scope": "instance", "inherits": "PIXI.WebGLManager#renderer", "inherited": true, "overrides": "PIXI.WebGLManager#renderer", "___id": "T000002R013956", "___s": true, "skip": true, "slug": "PIXI.ObjectRendererrenderer", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [ { "comment": "/**\n * @class\n * @memberof PIXI\n */", "meta": { "range": [ 66, 842 ], "filename": "WebGLManager.js", "lineno": 7, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": { "id": "astnode100026898", "name": "WebGLManager", "type": "ClassDeclaration", "paramnames": [ "renderer" ] } }, "kind": "class", "memberof": "PIXI", "name": "WebGLManager", "longname": "PIXI.WebGLManager", "scope": "static", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "

The renderer this manager works for.

", "name": "renderer" } ], "___id": "T000002R002488", "___s": true, "$methods": [ { "comment": "/**\n * Generic method called when there is a WebGL context change.\n *\n */", "meta": { "range": [ 569, 629 ], "filename": "WebGLManager.js", "lineno": 28, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": { "id": "astnode100026924", "name": "WebGLManager#onContextChange", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Generic method called when there is a WebGL context change.

", "name": "onContextChange", "longname": "PIXI.WebGLManager#onContextChange", "kind": "function", "memberof": "PIXI.WebGLManager", "scope": "instance", "params": [], "___id": "T000002R002492", "___s": true, "skip": true, "slug": "PIXI.WebGLManageronContextChange", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" }, { "comment": "/**\n * Generic destroy methods to be overridden by the subclass\n *\n */", "meta": { "range": [ 722, 840 ], "filename": "WebGLManager.js", "lineno": 37, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": { "id": "astnode100026928", "name": "WebGLManager#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Generic destroy methods to be overridden by the subclass

", "name": "destroy", "longname": "PIXI.WebGLManager#destroy", "kind": "function", "memberof": "PIXI.WebGLManager", "scope": "instance", "params": [], "___id": "T000002R002493", "___s": true, "skip": true, "slug": "PIXI.WebGLManagerdestroy", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" }, { "comment": "/**\n * Generic method called when there is a WebGL context change.\n *\n */", "meta": { "range": [ 569, 629 ], "filename": "WebGLManager.js", "lineno": 28, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": { "id": "astnode100101603", "name": "WebGLManager#onContextChange", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Generic method called when there is a WebGL context change.

", "name": "onContextChange", "longname": "PIXI.WebGLManager#onContextChange", "kind": "function", "memberof": "PIXI.WebGLManager", "scope": "instance", "params": [], "___id": "T000002R009426", "___s": true, "skip": true, "slug": "PIXI.WebGLManageronContextChange", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" }, { "comment": "/**\n * Generic destroy methods to be overridden by the subclass\n *\n */", "meta": { "range": [ 722, 840 ], "filename": "WebGLManager.js", "lineno": 37, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": { "id": "astnode100101607", "name": "WebGLManager#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Generic destroy methods to be overridden by the subclass

", "name": "destroy", "longname": "PIXI.WebGLManager#destroy", "kind": "function", "memberof": "PIXI.WebGLManager", "scope": "instance", "params": [], "___id": "T000002R009427", "___s": true, "skip": true, "slug": "PIXI.WebGLManagerdestroy", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" } ], "$attributes": [ { "comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */", "meta": { "range": [ 226, 367 ], "filename": "WebGLManager.js", "lineno": 14, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": {} }, "description": "

The renderer this manager works for.

", "kind": "member", "name": "renderer", "type": { "names": [ "PIXI.WebGLRenderer" ] }, "memberof": "PIXI.WebGLManager", "longname": "PIXI.WebGLManager#renderer", "scope": "instance", "___id": "T000002R002490", "___s": true, "skip": true, "slug": "PIXI.WebGLManagerrenderer", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" }, { "comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */", "meta": { "range": [ 226, 367 ], "filename": "WebGLManager.js", "lineno": 14, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers", "code": {} }, "description": "

The renderer this manager works for.

", "kind": "member", "name": "renderer", "type": { "names": [ "PIXI.WebGLRenderer" ] }, "memberof": "PIXI.WebGLManager", "longname": "PIXI.WebGLManager#renderer", "scope": "instance", "___id": "T000002R009424", "___s": true, "skip": true, "slug": "PIXI.WebGLManagerrenderer", "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [], "$augmentedBy": [ { "name": "BlendModeManager" }, { "name": "FilterManager" }, { "name": "MaskManager" }, { "name": "StencilManager" }, { "name": "ObjectRenderer" }, { "name": "BlendModeManager" }, { "name": "FilterManager" }, { "name": "MaskManager" }, { "name": "StencilManager" }, { "name": "ObjectRenderer" } ], "filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js" } ], "$augmentedBy": [ { "name": "GraphicsRenderer" }, { "name": "SpriteRenderer" }, { "name": "TilingSpriteRenderer" }, { "name": "MeshRenderer" }, { "name": "GraphicsRenderer" }, { "name": "SpriteRenderer" }, { "name": "TilingSpriteRenderer" }, { "name": "MeshRenderer" } ], "filepath": "core\\renderers\\webgl\\utils\\ObjectRenderer.js" } ], "$augmentedBy": [], "filepath": "core\\sprites\\webgl\\SpriteRenderer.js" }