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

{"class":{"name":"PIXI.WebGLRenderer","extends":"","static":false,"constructor":true,"parameters":[{"name":"[width=0]","type":["number"],"help":"the width of the canvas view","optional":false,"default":null},{"name":"[height=0]","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.antialias=false]","type":["boolean"],"help":"sets antialias (only applicable in chrome at the moment)","optional":false,"default":null},{"name":"[options.preserveDrawingBuffer=false]","type":["boolean"],"help":"enables drawing buffer preservation, enable this if you need to call toDataUrl on the webgl context","optional":false,"default":null},{"name":"[options.resolution=1]","type":["number"],"help":"the resolution of the renderer retina would be 2","optional":false,"default":null}],"help":"The WebGLRenderer draws the stage and all its content onto a webGL enabled canvas. This renderer\\nshould be used for browsers that support webGL. This Render works by automatically managing webGLBatchs.\\nSo no need for Sprite Batches or Sprite Clouds.\\nDon't forget to add the view to your DOM or you will not see anything :)"},"consts":[],"methods":{"public":[{"name":"destroy","static":false,"returns":null,"help":"Removes everything from the renderer (event listeners, spritebatch, etc...)","line":465,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"initContext","static":false,"returns":null,"help":"","line":231,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"mapBlendModes","static":false,"returns":null,"help":"Maps Pixi blend modes to WebGL blend modes.","line":496,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"render","static":false,"returns":null,"help":"Renders the stage to its webGL view","line":270,"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":"renderDisplayObject","static":false,"returns":null,"help":"Renders a Display Object.","line":340,"public":true,"protected":false,"private":false,"parameters":[{"name":"displayObject","type":["PIXI.DisplayObject"],"help":"The DisplayObject to render","optional":false,"default":null},{"name":"projection","type":["Phaser.Point"],"help":"The projection","optional":false,"default":null},{"name":"buffer","type":["array"],"help":"a standard WebGL buffer","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"resize","static":false,"returns":null,"help":"Resizes the webGL view to the specified width and height.","line":373,"public":true,"protected":false,"private":false,"parameters":[{"name":"width","type":["number"],"help":"the new width of the webGL view","optional":false,"default":null},{"name":"height","type":["number"],"help":"the new height of the webGL view","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateTexture","static":false,"returns":null,"help":"Updates and Creates a WebGL texture for the renderers context.","line":393,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"the texture to update","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[{"name":"handleContextLost","static":false,"returns":null,"help":"Handles a lost webgl context","line":433,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"handleContextRestored","static":false,"returns":null,"help":"Handles a restored webgl context","line":446,"public":false,"protected":false,"private":true,"parameters":[{"name":"event","type":["Event"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"blendModeManager","type":["PIXI.WebGLBlendModeManager"],"help":"Manages the blendModes","inlineHelp":"","line":199,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"clearBeforeRender","type":["boolean"],"help":"This sets if the WebGLRenderer will clear the context texture or not before the new render pass. If true:\\nIf the Stage is NOT transparent, Pixi will clear to alpha (0, 0, 0, 0).\\nIf the Stage is transparent, Pixi will clear to the target Stage's background color.\\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":87,"default":false,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"contextLostBound","type":["function"],"help":"","inlineHelp":"","line":121,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"contextRestoredBound","type":["function"],"help":"","inlineHelp":"","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterManager","type":["PIXI.WebGLFilterManager"],"help":"Manages the filters","inlineHelp":"","line":185,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the canvas view","inlineHelp":"","line":105,"default":"600","public":true,"protected":false,"private":false,"readOnly":false},{"name":"maskManager","type":["PIXI.WebGLMaskManager"],"help":"Manages the masks using the stencil buffer","inlineHelp":"","line":178,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"offset","type":["Phaser.Point"],"help":"","inlineHelp":"","line":155,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"preserveDrawingBuffer","type":["boolean"],"help":"The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.","inlineHelp":"","line":75,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"projection","type":["Phaser.Point"],"help":"","inlineHelp":"","line":149,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderSession","type":["object"],"help":"TODO remove","inlineHelp":"","line":206,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The resolution of the renderer","inlineHelp":"","line":57,"default":"1","public":true,"protected":false,"private":false,"readOnly":false},{"name":"shaderManager","type":["PIXI.WebGLShaderManager"],"help":"Deals with managing the shader programs and their attribs","inlineHelp":"","line":164,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteBatch","type":["PIXI.WebGLSpriteBatch"],"help":"Manages the rendering of sprites","inlineHelp":"","line":171,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stencilManager","type":["PIXI.WebGLStencilManager"],"help":"Manages the stencil buffer","inlineHelp":"","line":192,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"transparent","type":["boolean"],"help":"Whether the render view is transparent","inlineHelp":"","line":67,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"","line":48,"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":113,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the canvas view","inlineHelp":"","line":96,"default":"800","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_contextOptions","type":["object"],"help":"","inlineHelp":"","line":137,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}