phaser/resources/docgen/output/PIXI.CanvasRenderer.json

{"class":{"name":"PIXI.CanvasRenderer","extends":"","static":false,"constructor":true,"parameters":[{"name":"[width=800]","type":["number"],"help":"the width of the canvas view","optional":false,"default":null},{"name":"[height=600]","type":["number"],"help":"the height of the canvas view","optional":false,"default":null},{"name":"[options]","type":["object"],"help":"The optional renderer parameters","optional":false,"default":null},{"name":"[options.view]","type":["HTMLCanvasElement"],"help":"the canvas to use as a view, optional","optional":false,"default":null},{"name":"[options.transparent=false]","type":["boolean"],"help":"If the render view is transparent, default false","optional":false,"default":null},{"name":"[options.resolution=1]","type":["number"],"help":"the resolution of the renderer retina would be 2","optional":false,"default":null},{"name":"[options.clearBeforeRender=true]","type":["boolean"],"help":"This sets if the CanvasRenderer will clear the canvas or not before the new render pass.","optional":false,"default":null}],"help":"The CanvasRenderer draws the Stage and all its content onto a 2d canvas. This renderer should be used for browsers that do not support webGL.\\nDon't forget to add the CanvasRenderer.view to your DOM or you will not see anything :)"},"consts":[],"methods":{"public":[{"name":"render","static":false,"returns":null,"help":"Renders the Stage to this canvas view","line":180,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the Stage element to be rendered","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resize","static":false,"returns":null,"help":"Resizes the canvas view to the specified width and height","line":230,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"the new width of the canvas view","optional":false,"default":null},{"name":"height","type":["number"],"help":"the new height of the canvas view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"mapBlendModes","static":false,"returns":null,"help":"Maps Pixi blend modes to canvas blend modes.","line":263,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"renderDisplayObject","static":false,"returns":null,"help":"Renders a display object","line":250,"public":false,"protected":false,"private":true,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"The displayObject to render","optional":false,"default":null},{"name":"context","type":["CanvasRenderingContext2D"],"help":"the context 2d method of the canvas","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"CanvasMaskManager","type":["PIXI.CanvasMaskManager"],"help":"Instance of a PIXI.CanvasMaskManager, handles masking when using the canvas renderer","inlineHelp":"","line":135,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"clearBeforeRender","type":["boolean"],"help":"This sets if the CanvasRenderer will clear the canvas or not before the new render pass.\\nIf the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color.\\nIf the Stage is transparent Pixi will use clearRect to clear the canvas every frame.\\nDisable this by setting this to false. For example if your game has a canvas filling background image you often don't need this set.","inlineHelp":"","line":65,"default":false,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["CanvasRenderingContext2D"],"help":"The canvas 2d context that everything is drawn with","inlineHelp":"","line":109,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"count","type":["number"],"help":"Internal var.","inlineHelp":"","line":128,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the canvas view","inlineHelp":"","line":91,"default":"600","public":true,"protected":false,"private":false,"readOnly":false},{"name":"refresh","type":["boolean"],"help":"Boolean flag controlling canvas refresh.","inlineHelp":"","line":117,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderSession","type":["object"],"help":"The render session is just a bunch of parameter used for rendering","inlineHelp":"","line":142,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The resolution of the canvas.","inlineHelp":"","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"transparent","type":["boolean"],"help":"Whether the render view is transparent","inlineHelp":"","line":73,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"The renderer type.","inlineHelp":"","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"view","type":["HTMLCanvasElement"],"help":"The canvas element that everything is drawn to.","inlineHelp":"","line":102,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the canvas view","inlineHelp":"","line":82,"default":"800","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}