WebGLRenderer | RPGMakerMV Library

Hierarchy

SystemRenderer
- WebGLRenderer

Index

Constructors

constructor

Properties

Constructors

constructor

new WebGLRenderer(options?: WebGLRendererOptions): WebGLRenderer
new WebGLRenderer(screenWidth?: number, screenHeight?: number, options?: WebGLRendererOptions): WebGLRenderer

Overrides SystemRenderer.constructor
- Defined in node_modules/@types/pixi.js/index.d.ts:895
Parameters
- Optional options: WebGLRendererOptions
Returns WebGLRenderer
Overrides SystemRenderer.constructor
- Defined in node_modules/@types/pixi.js/index.d.ts:897
Parameters
- Optional screenWidth: number
- Optional screenHeight: number
- Optional options: WebGLRendererOptions
Returns WebGLRenderer

Properties

CONTEXT_UID

CONTEXT_UID: number

_activeRenderTarget

_activeRenderTarget: RenderTarget

Protected _activeShader

_activeShader: Shader

Protected _backgroundColor

_backgroundColor: number

Protected _backgroundColorRgba

_backgroundColorRgba: number[]

Protected _backgroundColorString

_backgroundColorString: string

Protected _contextOptions

_contextOptions: object

Type declaration

alpha: boolean
Optional antiAlias?: boolean
premultipliedAlpha: boolean
Optional preseveDrawingBuffer?: boolean
stencil: boolean

Protected _lastObjectRendered

_lastObjectRendered: DisplayObject

Protected _tempDisplayObjectParent

_tempDisplayObjectParent: Container

autoResize

autoResize: boolean

blendModes

blendModes: any

boundTextures

boundTextures: Texture[]

clearBeforeRender

clearBeforeRender: boolean

currentRenderer

currentRenderer: ObjectRenderer

Protected drawModes

drawModes: any

emptyRenderer

emptyRenderer: ObjectRenderer

extract

extract: WebGLExtract

filterManager

filterManager: FilterManager

gl

gl: WebGLRenderingContext

handleContextLost

handleContextLost: function

Type declaration

- (event: WebGLContextEvent): void
- Parameters
  - event: WebGLContextEvent
  Returns void

handleContextRestored

handleContextRestored: function

Type declaration

- (): void
- Returns void

height

height: number

interaction

interaction: InteractionManager

maskManager

maskManager: MaskManager

options

options: RendererOptions

plugins

plugins: any

preserveDrawingBuffer

preserveDrawingBuffer: boolean

renderingToScreen

renderingToScreen: boolean

resolution

resolution: number

roundPixels

roundPixels: boolean

screen

screen: Rectangle

Optional state

state: WebGLState

Optional stencilManager

stencilManager: StencilManager

Optional textureGC

textureGC: TextureGarbageCollector

Optional textureManager

textureManager: TextureManager

transparent

transparent: boolean

type

type: number

view

view: HTMLCanvasElement

width

width: number

Static EventEmitter

EventEmitter: object

Type declaration

constructor: function
- new __type(): EventEmitter
- - Defined in node_modules/@types/pixi.js/index.d.ts:2810
  Returns EventEmitter
prefixed: string | boolean

Static ___plugins

___plugins: any

Static prefixed

prefixed: string | boolean

Methods

Protected _initContext

_initContext(): void

- Defined in node_modules/@types/pixi.js/index.d.ts:924
Returns void

addListener

addListener(event: "prerender" | "postrender", fn: function, context?: any): this
addListener(event: "context", fn: function, context?: any): this

Overrides EventEmitter.addListener
- Defined in node_modules/@types/pixi.js/index.d.ts:954
Parameters
- event: "prerender" | "postrender"
- fn: function
  - - (): void
    - Returns void
- Optional context: any
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/pixi.js/index.d.ts:955
Parameters
- event: "context"
- fn: function
  - - (gl: WebGLRenderingContext): void
    - Parameters
      - gl: WebGLRenderingContext
      Returns void
- Optional context: any
Returns this

bindRenderTarget

bindRenderTarget(renderTarget: RenderTarget): WebGLRenderer

- Defined in node_modules/@types/pixi.js/index.d.ts:934
Parameters
- renderTarget: RenderTarget
Returns WebGLRenderer

bindRenderTexture

bindRenderTexture(renderTexture: RenderTexture, transform: Transform): WebGLRenderer

- Defined in node_modules/@types/pixi.js/index.d.ts:933
Parameters
- renderTexture: RenderTexture
- transform: Transform
Returns WebGLRenderer

bindShader

bindShader(shader: Shader, autoProject?: boolean): WebGLRenderer

- Defined in node_modules/@types/pixi.js/index.d.ts:935
Parameters
- shader: Shader
- Optional autoProject: boolean
Returns WebGLRenderer

bindTexture

bindTexture(texture: Texture | BaseTexture, location?: number, forceLocation?: boolean): number

- Defined in node_modules/@types/pixi.js/index.d.ts:936
Parameters
- texture: Texture | BaseTexture
- Optional location: number
- Optional forceLocation: boolean
Returns number

bindVao

bindVao(vao: VertexArrayObject): WebGLRenderer

- Defined in node_modules/@types/pixi.js/index.d.ts:939
Parameters
- vao: VertexArrayObject
Returns WebGLRenderer

clear

clear(clearColor?: number): void

- Defined in node_modules/@types/pixi.js/index.d.ts:930
Parameters
- Optional clearColor: number
Returns void

clearRenderTexture

clearRenderTexture(renderTexture: RenderTexture, clearColor?: number): WebGLRenderer

- Defined in node_modules/@types/pixi.js/index.d.ts:932
Parameters
- renderTexture: RenderTexture
- Optional clearColor: number
Returns WebGLRenderer

createVao

createVao(): VertexArrayObject

- Defined in node_modules/@types/pixi.js/index.d.ts:938
Returns VertexArrayObject

destroy

destroy(removeView?: boolean): void

Overrides SystemRenderer.destroy
- Defined in node_modules/@types/pixi.js/index.d.ts:943
Parameters
- Optional removeView: boolean
Returns void

destroyPlugins

destroyPlugins(): void

- Defined in node_modules/@types/pixi.js/index.d.ts:891
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/@types/pixi.js/index.d.ts:2852
Calls each of the listeners registered for a given event.

Parameters
- event: string | symbol
  
  The event name.
- Rest ...args: any[]
  
  Arguments that are passed to registered listeners
Returns boolean

true if the event had listeners, else false.

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/pixi.js/index.d.ts:2827
Return an array listing the events for which the emitter has registered listeners.

Returns Array<string | symbol>

flush

flush(): void

- Defined in node_modules/@types/pixi.js/index.d.ts:928
Returns void

generateTexture

generateTexture(displayObject: DisplayObject, scaleMode?: number, resolution?: number): RenderTexture

Inherited from SystemRenderer.generateTexture
- Defined in node_modules/@types/pixi.js/index.d.ts:819
Parameters
- displayObject: DisplayObject
- Optional scaleMode: number
- Optional resolution: number
Returns RenderTexture

initPlugins

initPlugins(): void

- Defined in node_modules/@types/pixi.js/index.d.ts:890
Returns void

listeners

listeners(event: string | symbol): Function[]
listeners(event: string | symbol, exists: boolean): boolean

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2835
Return the listeners registered for a given event.

Parameters
- event: string | symbol
  
  The event name.
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2844
Check if there listeners for a given event. If exists argument is not true lists listeners.

Parameters
- event: string | symbol
  
  The event name.
- exists: boolean
  
  Only check if there are listeners.
Returns boolean

off

off(event: "prerender" | "postrender", fn?: function, context?: any): this
off(event: "context", fn?: function, context?: any): this

Overrides EventEmitter.off
- Defined in node_modules/@types/pixi.js/index.d.ts:952
Parameters
- event: "prerender" | "postrender"
- Optional fn: function
  - - (): void
    - Returns void
- Optional context: any
Returns this
Overrides EventEmitter.off
- Defined in node_modules/@types/pixi.js/index.d.ts:953
Parameters
- event: "context"
- Optional fn: function
  - - (gl: WebGLRenderingContext): void
    - Parameters
      - gl: WebGLRenderingContext
      Returns void
- Optional context: any
Returns this

on

on(event: "prerender" | "postrender", fn: function, context?: any): this
on(event: "context", fn: function, context?: any): this

Overrides EventEmitter.on
- Defined in node_modules/@types/pixi.js/index.d.ts:945
Parameters
- event: "prerender" | "postrender"
- fn: function
  - - (): void
    - Returns void
- Optional context: any
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/pixi.js/index.d.ts:946
Parameters
- event: "context"
- fn: function
  - - (gl: WebGLRenderingContext): void
    - Parameters
      - gl: WebGLRenderingContext
      Returns void
- Optional context: any
Returns this

once

once(event: "prerender" | "postrender", fn: function, context?: any): this
once(event: "context", fn: function, context?: any): this

Overrides EventEmitter.once
- Defined in node_modules/@types/pixi.js/index.d.ts:947
Parameters
- event: "prerender" | "postrender"
- fn: function
  - - (): void
    - Returns void
- Optional context: any
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/pixi.js/index.d.ts:948
Parameters
- event: "context"
- fn: function
  - - (gl: WebGLRenderingContext): void
    - Parameters
      - gl: WebGLRenderingContext
      Returns void
- Optional context: any
Returns this

removeAllListeners

removeAllListeners(event: "prerender" | "postrender" | "context"): this

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/pixi.js/index.d.ts:951
Parameters
- event: "prerender" | "postrender" | "context"
Returns this

removeListener

removeListener(event: "prerender" | "postrender", fn?: function, context?: any): this
removeListener(event: "context", fn?: function, context?: any): this

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/pixi.js/index.d.ts:949
Parameters
- event: "prerender" | "postrender"
- Optional fn: function
  - - (): void
    - Returns void
- Optional context: any
Returns this
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/pixi.js/index.d.ts:950
Parameters
- event: "context"
- Optional fn: function
  - - (gl: WebGLRenderingContext): void
    - Parameters
      - gl: WebGLRenderingContext
      Returns void
- Optional context: any
Returns this

render

render(displayObject: DisplayObject, renderTexture?: RenderTexture, clear?: boolean, transform?: Transform, skipUpdateTransform?: boolean): void

Overrides SystemRenderer.render
- Defined in node_modules/@types/pixi.js/index.d.ts:926
Parameters
- displayObject: DisplayObject
- Optional renderTexture: RenderTexture
- Optional clear: boolean
- Optional transform: Transform
- Optional skipUpdateTransform: boolean
Returns void

reset

reset(): WebGLRenderer

- Defined in node_modules/@types/pixi.js/index.d.ts:940
Returns WebGLRenderer

resize

resize(screenWidth: number, screenHeight: number): void

Inherited from SystemRenderer.resize
- Defined in node_modules/@types/pixi.js/index.d.ts:818
Parameters
- screenWidth: number
- screenHeight: number
Returns void

setBlendMode

setBlendMode(blendMode: number): void

- Defined in node_modules/@types/pixi.js/index.d.ts:929
Parameters
- blendMode: number
Returns void

setMaxListeners

setMaxListeners(): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2905
This function doesn't apply anymore.

deprecated

Returns this

setObjectRenderer

setObjectRenderer(objectRenderer: ObjectRenderer): void

- Defined in node_modules/@types/pixi.js/index.d.ts:927
Parameters
- objectRenderer: ObjectRenderer
Returns void

setTransform

setTransform(matrix: Matrix): void

- Defined in node_modules/@types/pixi.js/index.d.ts:931
Parameters
- matrix: Matrix
Returns void

unbindTexture

unbindTexture(texture: Texture | BaseTexture): WebGLRenderer | undefined

- Defined in node_modules/@types/pixi.js/index.d.ts:937
Parameters
- texture: Texture | BaseTexture
Returns WebGLRenderer | undefined

Static registerPlugin

registerPlugin(pluginName: string, ctor: Function): void

- Defined in node_modules/@types/pixi.js/index.d.ts:888
Parameters
- pluginName: string
- ctor: Function
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: WebGLRendererOptions

Returns WebGLRenderer

Parameters

Optional screenWidth: number

Optional screenHeight: number

Optional options: WebGLRendererOptions

Returns WebGLRenderer

Properties

CONTEXT_UID

_activeRenderTarget

Protected _activeShader

Protected _backgroundColor

Protected _backgroundColorRgba

Protected _backgroundColorString

Protected _contextOptions

Type declaration

alpha: boolean

Optional antiAlias?: boolean

premultipliedAlpha: boolean

Optional preseveDrawingBuffer?: boolean

stencil: boolean

Protected _lastObjectRendered

Protected _tempDisplayObjectParent

autoResize

blendModes

boundTextures

clearBeforeRender

currentRenderer

Protected drawModes

emptyRenderer

extract

filterManager

gl

handleContextLost

Type declaration

Parameters

event: WebGLContextEvent

Returns void

handleContextRestored

Type declaration

Returns void

height

interaction

maskManager

options

plugins

preserveDrawingBuffer

renderingToScreen

resolution

roundPixels

screen

Optional state

Optional stencilManager

Optional textureGC

Optional textureManager

transparent

type

view

width

Static EventEmitter

Type declaration

constructor: function

Returns EventEmitter

prefixed: string | boolean

Static ___plugins

Static prefixed

Methods

Protected _initContext

Returns void

addListener

Parameters

event: "prerender" | "postrender"