CanvasRenderer | RPGMakerMV Library

Hierarchy

SystemRenderer
- CanvasRenderer

Index

Constructors

constructor

Methods

Constructors

constructor

new CanvasRenderer(options?: RendererOptions): CanvasRenderer
new CanvasRenderer(screenWidth?: number, screenHeight?: number, options?: RendererOptions): CanvasRenderer

Overrides SystemRenderer.constructor
- Defined in node_modules/@types/pixi.js/index.d.ts:834
Parameters
- Optional options: RendererOptions
Returns CanvasRenderer
Overrides SystemRenderer.constructor
- Defined in node_modules/@types/pixi.js/index.d.ts:836
Parameters
- Optional screenWidth: number
- Optional screenHeight: number
- Optional options: RendererOptions
Returns CanvasRenderer

Properties

Protected _backgroundColor

_backgroundColor: number

Protected _backgroundColorRgba

_backgroundColorRgba: number[]

Protected _backgroundColorString

_backgroundColorString: string

Protected _lastObjectRendered

_lastObjectRendered: DisplayObject

Protected _tempDisplayObjectParent

_tempDisplayObjectParent: Container

autoResize

autoResize: boolean

blendModes

blendModes: any

clearBeforeRender

clearBeforeRender: boolean

context

context: CanvasRenderingContext2D | null

extract

extract: CanvasExtract

height

height: number

plugins

plugins: any

preserveDrawingBuffer

preserveDrawingBuffer: boolean

refresh

refresh: boolean

resolution

resolution: number

rootContext

rootContext: CanvasRenderingContext2D

Optional rootResolution

rootResolution: number

roundPixels

roundPixels: boolean

screen

screen: Rectangle

smoothProperty

smoothProperty: string

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

addListener

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

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

clear

clear(clearColor?: string): void

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

destroy

destroy(removeView?: boolean): void

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

destroyPlugins

destroyPlugins(): void

- Defined in node_modules/@types/pixi.js/index.d.ts:830
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>

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:829
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

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

on

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

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

once

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

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

removeAllListeners

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

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

removeListener

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

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/pixi.js/index.d.ts:855
Parameters
- event: "prerender" | "postrender"
- Optional fn: function
  - - (): void
    - 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:848
Parameters
- displayObject: DisplayObject
- Optional renderTexture: RenderTexture
- Optional clear: boolean
- Optional transform: Transform
- Optional skipUpdateTransform: boolean
Returns void

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:849
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

Static registerPlugin

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

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: RendererOptions

Returns CanvasRenderer

Parameters

Optional screenWidth: number

Optional screenHeight: number

Optional options: RendererOptions

Returns CanvasRenderer

Properties

Protected _backgroundColor

Protected _backgroundColorRgba

Protected _backgroundColorString

Protected _lastObjectRendered

Protected _tempDisplayObjectParent

autoResize

blendModes

clearBeforeRender

context

extract

height

Optional interaction

maskManager

options

plugins

preserveDrawingBuffer

refresh

resolution

rootContext

Optional rootResolution

roundPixels

screen

smoothProperty

transparent

type

view

width

Static EventEmitter

Type declaration

constructor: function

Returns EventEmitter

prefixed: string | boolean

Static ___plugins

Static prefixed

Methods

addListener

Parameters

event: "prerender" | "postrender"

fn: function

Returns void

Optional context: any

Returns this

clear

Parameters

Optional clearColor: string

Returns void

destroy

Parameters

Optional removeView: boolean

Returns void

destroyPlugins

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

generateTexture

Parameters

displayObject: DisplayObject

Optional scaleMode: number

Optional resolution: number