Home

class: CanvasSpriteRenderer

Renderer dedicated to drawing and batching sprites.

Methods summary

Public methods
public	render(sprite: PIXI.Sprite): void
public	destroy(): void
public	render(sprite: PIXI.Sprite): void
public	destroy(): void

Methods

render(sprite: PIXI.Sprite): void

core\sprites\canvas\CanvasSpriteRenderer.js, line 44

Renders the sprite object.

Params:

Name	Type	Attribute	Description
sprite			the sprite to render when using this spritebatch

Returns:

void

destroy(): void

core\sprites\canvas\CanvasSpriteRenderer.js, line 172

destroy the sprite object.

Returns:

void

render(sprite: PIXI.Sprite): void

core\sprites\canvas\CanvasSpriteRenderer.js, line 44

Renders the sprite object.

Params:

Name	Type	Attribute	Description
sprite			the sprite to render when using this spritebatch

Returns:

void

destroy(): void

core\sprites\canvas\CanvasSpriteRenderer.js, line 172

destroy the sprite object.

Returns:

void

{ "comment": "/**\n * Renderer dedicated to drawing and batching sprites.\n *\n * @class\n * @private\n * @memberof PIXI\n */", "meta": { "range": [ 868, 5415 ], "filename": "CanvasSpriteRenderer.js", "lineno": 29, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\canvas", "code": { "id": "astnode100032238", "name": "CanvasSpriteRenderer", "type": "ClassDeclaration", "paramnames": [ "renderer" ] } }, "classdesc": "

Renderer dedicated to drawing and batching sprites.

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

The renderer sprite this batch works for.

", "name": "renderer" } ], "___id": "T000002R002948", "___s": true, "$methods": [ { "comment": "/**\n * Renders the sprite object.\n *\n * @param {PIXI.Sprite} sprite - the sprite to render when using this spritebatch\n */", "meta": { "range": [ 1220, 5299 ], "filename": "CanvasSpriteRenderer.js", "lineno": 44, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\canvas", "code": { "id": "astnode100032252", "name": "CanvasSpriteRenderer#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.CanvasSpriteRenderer#render", "kind": "function", "memberof": "PIXI.CanvasSpriteRenderer", "scope": "instance", "___id": "T000002R002951", "___s": true, "skip": true, "slug": "PIXI.CanvasSpriteRendererrender", "filepath": "core\\sprites\\canvas\\CanvasSpriteRenderer.js" }, { "comment": "/**\n * destroy the sprite object.\n *\n */", "meta": { "range": [ 5362, 5413 ], "filename": "CanvasSpriteRenderer.js", "lineno": 172, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\canvas", "code": { "id": "astnode100032750", "name": "CanvasSpriteRenderer#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

destroy the sprite object.

", "name": "destroy", "longname": "PIXI.CanvasSpriteRenderer#destroy", "kind": "function", "memberof": "PIXI.CanvasSpriteRenderer", "scope": "instance", "params": [], "___id": "T000002R002976", "___s": true, "skip": true, "slug": "PIXI.CanvasSpriteRendererdestroy", "filepath": "core\\sprites\\canvas\\CanvasSpriteRenderer.js" }, { "comment": "/**\n * Renders the sprite object.\n *\n * @param {PIXI.Sprite} sprite - the sprite to render when using this spritebatch\n */", "meta": { "range": [ 1220, 5299 ], "filename": "CanvasSpriteRenderer.js", "lineno": 44, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\canvas", "code": { "id": "astnode100106931", "name": "CanvasSpriteRenderer#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.CanvasSpriteRenderer#render", "kind": "function", "memberof": "PIXI.CanvasSpriteRenderer", "scope": "instance", "___id": "T000002R009885", "___s": true, "skip": true, "slug": "PIXI.CanvasSpriteRendererrender", "filepath": "core\\sprites\\canvas\\CanvasSpriteRenderer.js" }, { "comment": "/**\n * destroy the sprite object.\n *\n */", "meta": { "range": [ 5362, 5413 ], "filename": "CanvasSpriteRenderer.js", "lineno": 172, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites\\canvas", "code": { "id": "astnode100107429", "name": "CanvasSpriteRenderer#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

destroy the sprite object.