Module `Renderer-PIXI`

type webGLRenderingContext;
type jsClassRef;

let createOptions: ?⁠width:float => ?⁠height:float => ?⁠view:Webapi.Dom.HtmlElement.t => ?⁠transparent:bool => ?⁠autoDensity:bool => ?⁠antialias:bool => ?⁠forceFXAA:bool => ?⁠resolution:float => ?⁠clearBeforeRender:bool => ?⁠preserveDrawingBuffer:bool => ?⁠backgroundColor:int => ?⁠context:Js.t({.. }) => unit => Js.t({. width: Js.undefined(float), height: Js.undefined(float), view: Js.undefined(Webapi.Dom.HtmlElement.t), transparent: Js.undefined(bool), autoDensity: Js.undefined(bool), antialias: Js.undefined(bool), forceFXAA: Js.undefined(bool), resolution: Js.undefined(float), clearBeforeRender: Js.undefined(bool), preserveDrawingBuffer: Js.undefined(bool), backgroundColor: Js.undefined(int), context: Js.undefined(Js.t({.. })), });

class type _t = { ... }

type t = Js.t(_t);

let registerPlugin: pluginName:string => ctor:Js.Types.function_val => unit;

Adds a plugin to the renderer

parameter pluginName: The name of the plugin

parameter ctor: The constructor function or class for the plugin

module Impl: { ... };

include PIXI.EventEmitter.Impl;

let create: unit => PIXI.EventEmitter.t;
let eventNames: Js.t(PIXI.EventEmitter._t) => array(string);
let listeners: Js.t(PIXI.EventEmitter._t) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => array((Js.t({.. }) => unit));
let listenerCount: Js.t(PIXI.EventEmitter._t) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => int;
let emit: Js.t(PIXI.EventEmitter._t) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => bool;
let on: Js.t(PIXI.EventEmitter._t as 'd) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => fn:('b => unit) => ?⁠context:'c => unit => Js.t('d);
let addListener: Js.t(PIXI.EventEmitter._t as 'd) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => fn:('b => unit) => ?⁠context:'c => unit => Js.t('d);
let once: Js.t(PIXI.EventEmitter._t as 'd) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => fn:('b => unit) => ?⁠context:'c => unit => Js.t('d);
let removeListener: Js.t(PIXI.EventEmitter._t as 'b) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => ?⁠fn:(Js.t({.. }) => unit) => ?⁠context:Js.t({.. }) => ?⁠once:bool => unit => Js.t('b);
let off: Js.t(PIXI.EventEmitter._t as 'b) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => ?⁠fn:(Js.t({.. }) => unit) => ?⁠context:Js.t({.. }) => ?⁠once:bool => unit => Js.t('b);
let removeAllListeners: Js.t(PIXI.EventEmitter._t as 'b) => ?⁠event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => unit => Js.t('b);

include PIXI.AbstractRenderer.Impl;

let _create: system:string => ?⁠options:'a => unit => PIXI.AbstractRenderer.t;

let create: system:string => ?⁠options:Js.t({. antialias: Js.undefined(bool), autoDensity: Js.undefined(bool), backgroundColor: Js.undefined(int), clearBeforeRender: Js.undefined(bool), height: Js.undefined(float), preserveDrawingBuffer: Js.undefined(bool), resolution: Js.undefined(float), transparent: Js.undefined(bool), view: Js.undefined(Webapi.Dom.HtmlElement.t), width: Js.undefined(float), }) => unit => PIXI.AbstractRenderer.t;

let getAutoDensity: Js.t(PIXI.AbstractRenderer._t) => bool;
let setAutoDensity: Js.t(PIXI.AbstractRenderer._t) => bool => unit;
let getBackgroundColor: Js.t(PIXI.AbstractRenderer._t) => int;
let setBackgroundColor: Js.t(PIXI.AbstractRenderer._t) => int => unit;
let getCleanBeforeRender: Js.t(PIXI.AbstractRenderer._t) => bool;
let setCleanBeforeRender: Js.t(PIXI.AbstractRenderer._t) => bool => unit;
let getHeight: Js.t(PIXI.AbstractRenderer._t) => float;
let getOptions: Js.t(PIXI.AbstractRenderer._t) => 'a;
let getPlugins: Js.t(PIXI.AbstractRenderer._t) => PIXI.AbstractRenderer.rendererPlugins;
let getPreserveDrawingBuffer: Js.t(PIXI.AbstractRenderer._t) => bool;
let setPreserveDrawingBuffer: Js.t(PIXI.AbstractRenderer._t) => bool => unit;
let getResolution: Js.t(PIXI.AbstractRenderer._t) => float;
let setResolution: Js.t(PIXI.AbstractRenderer._t) => float => unit;
let getScreen: Js.t(PIXI.AbstractRenderer._t) => Js.t(PIXI.Rectangle._t);
let setScreen: Js.t(PIXI.AbstractRenderer._t) => Js.t(PIXI.Rectangle._t) => unit;
let getTransparent: Js.t(PIXI.AbstractRenderer._t) => bool;
let setTransparent: Js.t(PIXI.AbstractRenderer._t) => bool => unit;
let _getType: Js.t(PIXI.AbstractRenderer._t) => int;

let getType: Js.t(PIXI.AbstractRenderer._t) => PIXI.RENDERER_TYPE.t;

let getView: Js.t(PIXI.AbstractRenderer._t) => Dom.element;
let setView: Js.t(PIXI.AbstractRenderer._t) => Dom.element => unit;
let getWidth: Js.t(PIXI.AbstractRenderer._t) => float;
let destroy: Js.t(PIXI.AbstractRenderer._t) => ?⁠removeView:bool => unit => unit;
let generateTexture: Js.t(PIXI.AbstractRenderer._t) => displayObject:PIXI.AbstractRenderer.displayObjectOpaque => scaleMode:int => resolution:float => ?⁠region:Js.t(PIXI.Rectangle._t) => unit => PIXI.AbstractRenderer.renderTextureOpaque;
let initPlugins: Js.t(PIXI.AbstractRenderer._t) => staticMap:'a => unit;
let resize: Js.t(PIXI.AbstractRenderer._t) => screenWidth:float => screenHeight:float => unit;

include Impl;

let _create: ?⁠options:'a => unit => t;

let create: ?⁠options:Js.t({. antialias: Js.undefined(bool), autoDensity: Js.undefined(bool), backgroundColor: Js.undefined(int), clearBeforeRender: Js.undefined(bool), context: Js.undefined(Js.t({.. })), forceFXAA: Js.undefined(bool), height: Js.undefined(float), preserveDrawingBuffer: Js.undefined(bool), resolution: Js.undefined(float), transparent: Js.undefined(bool), view: Js.undefined(Webapi.Dom.HtmlElement.t), width: Js.undefined(float), }) => unit => t;

creates a new renderer

see /bs-pixi/PIXI/Renderer-PIXI/#val-createOptions: for options Renderer.createOptions

parameter options: The optional renderer parameters

let getBatch: Js.t(_t) => PIXI.Systems.BatchSystem.t;: Batch system instance

let getContext: Js.t(_t) => PIXI.Systems.ContextSystem.t;: Context system intance

let getExtract: Js.t(_t) => PIXI.Extract.Extract.t;: Collection of methods for extracting data (image, pixels, etc.) from a display object or render texture

let getFilter: Js.t(_t) => PIXI.Systems.FilterSystem.t;: Filter system instance

let getFramebuffer: Js.t(_t) => PIXI.Systems.FramebufferSystem.t;: Framebuffer system instance

let getGeometry: Js.t(_t) => PIXI.Systems.BatchSystem.t;: Geometry system instance

let getGl: Js.t(_t) => webGLRenderingContext;: WebGL context, set by the contextSystem (this.context)

let getGlobalUniforms: Js.t(_t) => PIXI.UniformGroup.t;: Global uniforms

let setGlobalUniforms: Js.t(_t) => PIXI.UniformGroup.t => unit;: Global uniforms

let getProjection: Js.t(_t) => PIXI.Systems.ProjectionSystem.t;: Projection system instance

let getRenderingToScreen: Js.t(_t) => bool;: Flag if we are rendering to the screen vs renderTexture

let getRenderTexture: Js.t(_t) => PIXI.Systems.RenderTextureSystem.t;: RenderTexture system instance

let getScissor: Js.t(_t) => PIXI.Systems.ScissorSystem.t;: Scissor system instance

let getShader: Js.t(_t) => PIXI.Systems.ShaderSystem.t;: Shader system instance

let getState: Js.t(_t) => PIXI.Systems.StateSystem.t;: State system instance

let getStencil: Js.t(_t) => PIXI.Systems.StencilSystem.t;: Stencil system instance

let getTexture: Js.t(_t) => PIXI.Systems.TextureSystem.t;: Texture system instance

let getTextureGC: Js.t(_t) => PIXI.Systems.TextureGCSystem.t;: Texture garbage collector system instance

let addSystem: Js.t(_t) => classRef:jsClassRef => ?⁠name:string => unit => Js.t(_t);

Add a new system to the renderer.

parameter classRef: Class Reference

parameter name: Property name for system, if not specified will use a static name property on the class itself. This name will be assigned as s property on the Renderer so make sure it doesn't collide with properties on Renderer

returns: Return instance of renderer

let clear: Js.t(_t) => unit;: Clear the frame buffer

let destroy: Js.t(_t) => ?⁠removeView:bool => unit => unit;

Removes everything from the renderer (event listeners, spritebatch, etc...)

parameter removeView: Removes the Canvas element from the DOM

let render: Js.t(_t) => displayObject:PIXI.AbstractRenderer.displayObjectOpaque => ?⁠renderTexture:PIXI.AbstractRenderer.renderTextureOpaque => ?⁠clear:bool => ?⁠transform:Js.t(PIXI.Matrix.#_t) => ?⁠skipUpdateTransform:bool => unit => unit;

Renders the object to its WebGL view

parameter displayObject: The object to be rendered

parameter renderTexture: The render texture to render to

parameter clear: Should the canvas be cleared before the new render

parameter transform: A transform to apply to the render texture before rendering

parameter skipUpdateTransform: Should we skip the update transform pass?

let reset: Js.t(_t) => Js.t(_t);

Resets the WebGL state so you can render things however you fancy

returns: itself

let resize: Js.t(_t) => screenWidth:float => screenHeight:float => unit;

Resizes the WebGL view to the specified width and height

parameter screenWidth: The new width of the screen

parameter screenHeight: The new height of the screen