Class Renderer

Hierarchy

AbstractRenderer
- Renderer

Index

Constructors

constructor

Properties

Constructors

constructor

new Renderer(options?: IRendererOptions): Renderer

Overrides AbstractRenderer.constructor
- Defined in src/Renderer/index.ts:31
Parameters
- Optional options: IRendererOptions
  
  Create options
Returns Renderer

Properties

Private _adapter

_adapter: GPUAdapter = null

Private _beginFrameTimestamp

_beginFrameTimestamp: number = 0

Private _context

_context: GPUCanvasContext = null

Private _device

_device: GPUDevice = null

Private _lastFrameTimestamp

_lastFrameTimestamp: number = 0

Private _queueCommander

_queueCommander: QueueCommander = null

Private _swapchain

_swapchain: GPUSwapChain = null

Private _swapchainFormat

_swapchainFormat: TEXTURE_FORMAT = null

Private _swapchainTexture

_swapchainTexture: Texture = null

Static prefixed

prefixed: string | boolean

Methods

Private _createAdapter

_createAdapter(): Promise<GPUAdapter>

- Defined in src/Renderer/index.ts:227
Creates a WGPU adapter

Returns Promise<GPUAdapter>

Private _createContext

_createContext(): GPUCanvasContext

- Defined in src/Renderer/index.ts:265
Creates a WGPU context

Returns GPUCanvasContext

Private _createDevice

_createDevice(): Promise<GPUDevice>

- Defined in src/Renderer/index.ts:245
Creates a WGPU device

Returns Promise<GPUDevice>

Private _createSwapchain

_createSwapchain(): GPUSwapChain

- Defined in src/Renderer/index.ts:276
Creates a WGPU swapchain

Returns GPUSwapChain

Private _onDeviceError

_onDeviceError(error: Event): void

- Defined in src/Renderer/index.ts:292
Called in case of an device error

Parameters
- error: Event
  
  The error message
Returns void

Private _resolveSwapchainFormat

_resolveSwapchainFormat(): Promise<TEXTURE_FORMAT>

- Defined in src/Renderer/index.ts:211
Resolves the texture format of the swapchain

Returns Promise<TEXTURE_FORMAT>

Private _updateSwapchainTexture

_updateSwapchainTexture(): void

- Defined in src/Renderer/index.ts:299
Update the swapchain texture

Returns void

addListener

addListener<T>(event: T, fn: EventEmitter.EventListener<string | symbol, T>, context?: any): this

Inherited from AbstractCamera.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45
Type parameters
- T: EventEmitter.EventNames<string | symbol>
Parameters
- event: T
- fn: EventEmitter.EventListener<string | symbol, T>
- Optional context: any
Returns this

create

create(): Promise<Renderer>

- Defined in src/Renderer/index.ts:78
Create the renderer

Returns Promise<Renderer>

destroy

destroy(): void

Overrides AbstractRenderer.destroy
- Defined in src/Renderer/index.ts:200
Destroy this Object

Returns void

emit

emit<T>(event: T, ...args: EventEmitter.EventArgs<string | symbol, T>): boolean

Inherited from AbstractCamera.emit
- Defined in node_modules/eventemitter3/index.d.ts:32
Calls each of the listeners registered for a given event.

Type parameters
- T: EventEmitter.EventNames<string | symbol>
Parameters
- event: T
- Rest ...args: EventEmitter.EventArgs<string | symbol, T>
Returns boolean

eventNames

eventNames(): Array<EventEmitter.EventNames<string | symbol>>

Inherited from AbstractCamera.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15
Return an array listing the events for which the emitter has registered listeners.

Returns Array<EventEmitter.EventNames<string | symbol>>

flush

flush(): Promise<void>

- Defined in src/Renderer/index.ts:147
Flushes all pending operations such as buffer copies

Returns Promise<void>

getAdapter

getAdapter(): GPUAdapter

- Defined in src/Renderer/index.ts:48
The WGPU adapter

Returns GPUAdapter

getCanvas

getCanvas(): HTMLCanvasElement

Inherited from AbstractRenderer.getCanvas
- Defined in src/Renderer/AbstractRenderer.ts:40
The rendering surface to render into TODO: allow other targets such as FBOs

Returns HTMLCanvasElement

getContext

getContext(): GPUCanvasContext

- Defined in src/Renderer/index.ts:53
The WGPU canvas context

Returns GPUCanvasContext

getDevice

getDevice(): GPUDevice

- Defined in src/Renderer/index.ts:43
The WGPU device

Returns GPUDevice

getHeight

getHeight(): number

Inherited from AbstractRenderer.getHeight
- Defined in src/Renderer/AbstractRenderer.ts:50
The height of the rendering surface

Returns number

getQueueCommander

getQueueCommander(): QueueCommander

- Defined in src/Renderer/index.ts:63
The queue commander

Returns QueueCommander

getSwapchain

getSwapchain(): GPUSwapChain

- Defined in src/Renderer/index.ts:58
The WGPU swapchain

Returns GPUSwapChain

getSwapchainFormat

getSwapchainFormat(): TEXTURE_FORMAT

- Defined in src/Renderer/index.ts:73
The texture format of the swapchain

Returns TEXTURE_FORMAT

getSwapchainTexture

getSwapchainTexture(): Texture

- Defined in src/Renderer/index.ts:68
The swapchain texture

Returns Texture

getWidth

getWidth(): number

Inherited from AbstractRenderer.getWidth
- Defined in src/Renderer/AbstractRenderer.ts:45
The width of the rendering surface

Returns number

listenerCount

listenerCount(event: EventEmitter.EventNames<string | symbol>): number

Inherited from AbstractCamera.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27
Return the number of listeners listening to a given event.

Parameters
- event: EventEmitter.EventNames<string | symbol>
Returns number

listeners

listeners<T>(event: T): Array<EventEmitter.EventListener<string | symbol, T>>

Inherited from AbstractCamera.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20
Return the listeners registered for a given event.

Type parameters
- T: EventEmitter.EventNames<string | symbol>
Parameters
- event: T
Returns Array<EventEmitter.EventListener<string | symbol, T>>

off

off<T>(event: T, fn?: EventEmitter.EventListener<string | symbol, T>, context?: any, once?: boolean): this

Inherited from AbstractCamera.off
- Defined in node_modules/eventemitter3/index.d.ts:69
Type parameters
- T: EventEmitter.EventNames<string | symbol>
Parameters
- event: T
- Optional fn: EventEmitter.EventListener<string | symbol, T>
- Optional context: any
- Optional once: boolean
Returns this

on

on<T>(event: T, fn: EventEmitter.EventListener<string | symbol, T>, context?: any): this

Inherited from AbstractCamera.on
- Defined in node_modules/eventemitter3/index.d.ts:40
Add a listener for a given event.

Type parameters
- T: EventEmitter.EventNames<string | symbol>
Parameters
- event: T
- fn: EventEmitter.EventListener<string | symbol, T>
- Optional context: any
Returns this

once

once<T>(event: T, fn: EventEmitter.EventListener<string | symbol, T>, context?: any): this

Inherited from AbstractCamera.once
- Defined in node_modules/eventemitter3/index.d.ts:54
Add a one-time listener for a given event.

Type parameters
- T: EventEmitter.EventNames<string | symbol>
Parameters
- event: T
- fn: EventEmitter.EventListener<string | symbol, T>
- Optional context: any
Returns this

processUniformUpdateQueue

processUniformUpdateQueue(queue: IUniformUpdateEntry[], uniformResources: IBindGroupResource[]): void

- Defined in src/Renderer/index.ts:156
Process the uniform update queue

Parameters
- queue: IUniformUpdateEntry[]
  
  The uniform queue to process
- uniformResources: IBindGroupResource[]
Returns void

removeAllListeners

removeAllListeners(event?: EventEmitter.EventNames<string | symbol>): this

Inherited from AbstractCamera.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79
Remove all listeners, or those of the specified event.

Parameters
- Optional event: EventEmitter.EventNames<string | symbol>
Returns this

removeListener

removeListener<T>(event: T, fn?: EventEmitter.EventListener<string | symbol, T>, context?: any, once?: boolean): this

Inherited from AbstractCamera.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63
Remove the listeners of a given event.

Type parameters
- T: EventEmitter.EventNames<string | symbol>
Parameters
- event: T
- Optional fn: EventEmitter.EventListener<string | symbol, T>
- Optional context: any
- Optional once: boolean
Returns this

render

render(frame: Frame): void

Overrides AbstractRenderer.render
- Defined in src/Renderer/index.ts:115
Render a frame

Parameters
- frame: Frame
  
  The frame to render
Returns void

resize

resize(width: number, height: number): void

Overrides AbstractRenderer.resize
- Defined in src/Renderer/index.ts:104
Resize the renderer

Parameters
- width: number
  
  The destination width after resize
- height: number
  
  The destination height after resize
Returns void

Generated using TypeDoc