Class Renderer

Create a renderer. This is responsible for bringing together the whole state and, eventually, rendering to screen.

Constructors

constructor

new Renderer(__namedParameters?): Renderer
create a renderer
Parameters
- __namedParameters: Partial<RendererOptions> = {}
  The parameters to initialise the renderer.
Returns Renderer
- Defined in src/lib/core/Renderer.ts:173

Properties

alpha

alpha: boolean

Whether to render an alpha channel. This property is passed to the rendering context.

Default

false

autoClear

autoClear: boolean

Whether to automatically clear the buffers before render.

Default

true

bindVertexArray

bindVertexArray: ((vertexArray: null | WebGLVertexArrayObject) => void)

The WebGL2RenderingContext.bindVertexArray() method of the WebGL 2 API binds a passed WebGLVertexArrayObject object to the buffer.

colour

colour: boolean

Whether to clear the color bit

Default

true

createVertexArray

createVertexArray: (() => WebGLVertexArrayObject)

The WebGL2RenderingContext.createVertexArray() method of the WebGL 2 API creates and initializes a WebGLVertexArrayObject object that represents a vertex array object (VAO) pointing to vertex array data and which provides names for different sets of vertex data.

currentGeometry

currentGeometry: string

Stores the current geometry being rendered. Used to otimise geo rendering.

currentProgram

currentProgram: number

deleteVertexArray

deleteVertexArray: ((vertexArray: WebGLVertexArrayObject) => void)

The WebGL2RenderingContext.deleteVertexArray() method of the WebGL 2 API deletes a given WebGLVertexArrayObject object.

depth

depth: boolean

Whether to render a depth buffer. This property is passed to the rendering context.

Default

true

dpr

dpr: number

The pixel aspect ratio of the renderer.

Default

window.devicePixelRatio or 2, whichever is smaller.

drawArraysInstanced

drawArraysInstanced: ((mode: number, first: number, count: number, instanceCound: number) => void)

The WebGL2RenderingContext.drawArraysInstanced() method of the WebGL 2 API renders primitives from array data like the gl.drawArrays() method. In addition, it can execute multiple instances of the range of elements.

drawBuffers

drawBuffers: ((buffers: number[]) => void)

The WebGL2RenderingContext.drawBuffers() method of the WebGL 2 API defines draw buffers to which fragment colors are written into. The draw buffer settings are part of the state of the currently bound framebuffer or the drawingbuffer if no framebuffer is bound.

drawElementsInstanced

drawElementsInstanced: ((mode: number, count: number, type: number, offset: number, instanceCount: number) => void)

The WebGL2RenderingContext.drawElementsInstanced() method of the WebGL 2 API renders primitives from array data like the gl.drawElements() method. In addition, it can execute multiple instances of a set of elements.

extensions

extensions: WTCGLExtensions

Stores the enabled extensions

gl

gl: WTCGLRenderingContext

The WTCGL rendering context.

isWebgl2

isWebgl2: boolean

Whether the context we've retrieved is webGL2 or not.

parameters

parameters: WTCGLRendererParams

Stored device parameters such as max allowable units etc.

premultipliedAlpha

premultipliedAlpha: boolean

Whether to use premultiplied alphs. This property is passed to the rendering context.

Default

false

state

state: WTCGLRendererState

The rendering state. Allows us to avoid redundant calls on methods used internally

stencil

stencil: boolean

Whether to render a stencil buffer. This property is passed to the rendering context.

Default

false

vertexAttribDivisor

vertexAttribDivisor: ((index: number, divisor: number) => void)

The WebGL2RenderingContext.vertexAttribDivisor() method of the WebGL 2 API modifies the rate at which generic vertex attributes advance when rendering multiple instances of primitives with

Accessors

activeTexture

get activeTexture(): number
Returns number
- Defined in src/lib/core/Renderer.ts:481
set activeTexture(value): void
Sets the active texture value
Parameters
- value: number
Returns void
- Defined in src/lib/core/Renderer.ts:476

cullFace

get cullFace(): null | number
Returns null | number
- Defined in src/lib/core/Renderer.ts:433
set cullFace(value): void
Sets the cull face bit
Parameters
- value: number
Returns void
- Defined in src/lib/core/Renderer.ts:428

depthFunc

get depthFunc(): null | number
Returns null | number
- Defined in src/lib/core/Renderer.ts:469
set depthFunc(value): void
Sets the depth function bit
Parameters
- value: number
Returns void
- Defined in src/lib/core/Renderer.ts:464

depthMask

get depthMask(): boolean
Returns boolean
- Defined in src/lib/core/Renderer.ts:457
set depthMask(value): void
Sets the depth mask bit
Parameters
- value: boolean
Returns void
- Defined in src/lib/core/Renderer.ts:452

dimensions

get dimensions(): Vec2
Returns Vec2
- Defined in src/lib/core/Renderer.ts:318
set dimensions(v): void
Parameters
- v: Vec2
Returns void
- Defined in src/lib/core/Renderer.ts:312

frontFace

get frontFace(): null | number
Returns null | number
- Defined in src/lib/core/Renderer.ts:445
set frontFace(value): void
Sets the front face bit
Parameters
- value: number
Returns void
- Defined in src/lib/core/Renderer.ts:440

Methods

bindFramebuffer

bindFramebuffer(__namedParameters?): void
Binds a given WebGLFramebuffer to a target .
Parameters
- __namedParameters: {
  buffer?: null | WebGLFramebuffer;
  target?: number;
  } = {}
  - Optionalbuffer?: null | WebGLFramebuffer
  - Optionaltarget?: number
Returns void
- Defined in src/lib/core/Renderer.ts:492

disable

disable(id): void
Disables specific WebGL capabilities for this context.
Parameters
- id: number
  The ID of the capability to enable
Returns void
- Defined in src/lib/core/Renderer.ts:364

enable

enable(id): void
Enables specific WebGL capabilities for this context. See MDN for more details
Parameters
- id: number
  The ID of the capability to enable
Returns void
- Defined in src/lib/core/Renderer.ts:352

getExtension

getExtension(extension, webgl2Func?, extFunc?): any
Finds and enables a webGL extension and, if it has a corresponding function, returns that.
Parameters
- extension: string
  The extension identifier.
- Optionalwebgl2Func: string
  The name of the webGL2 function to return.
- OptionalextFunc: string
  The name of the webGL1 functiont to return.
Returns any
- A WebGL function, bound to this renderer or null (if no function exists)
- Defined in src/lib/core/Renderer.ts:508

getRenderList

getRenderList(__namedParameters): Drawable[]
Retrieves the list of renderable objects sorted by position, explicit render order and applied depth
Parameters
- __namedParameters: {
      camera?: Camera;
      frustumCull: boolean;
      scene: Obj;
      sort: boolean;
  }
  - Optionalcamera?: Camera
  - frustumCull: boolean
  - scene: Obj
  - sort: boolean
Returns Drawable[]
- An array of renderable objects
- Defined in src/lib/core/Renderer.ts:603

render

render(__namedParameters): void
Renders a scene
Parameters
- __namedParameters: RenderOptions
Returns void
- Defined in src/lib/core/Renderer.ts:682

setBlendEquation

setBlendEquation(modeRGB, modeAlpha): void
Sets a blending function for use in the application. See MDN for more information
Parameters
- modeRGB: number
  The function to be used in RGB models
- modeAlpha: number
  The functions to be used for both RGB and alpha models
Returns void
- Defined in src/lib/core/Renderer.ts:411

setBlendFunc

setBlendFunc(src, dst, srcAlpha?, dstAlpha?): void
Set's various blend functions are used for blending pixel calculations See MDN for more details If alpha functions are provided, this will call gl.blendFuncSeparate, otherwise blendFunc
Parameters
- src: number
  A WebGL_API.Types specifying a multiplier for the RGB source blending factors.
- dst: number
  A WebGL_API.Types specifying a multiplier for the RGB destination blending factors.
- OptionalsrcAlpha: number
  A WebGL_API.Types specifying a multiplier for the alpha source blending factor.
- OptionaldstAlpha: number
  A WebGL_API.Types specifying a multiplier for the alpha destination blending factor.
Returns void
- Defined in src/lib/core/Renderer.ts:381

setViewport

setViewport(dimensions, position): void
Set up the viewport for rendering.
Parameters
- dimensions: Vec2
  The dimensions of the viewport
- position: Vec2
  The position of the viewport
Returns void
- Defined in src/lib/core/Renderer.ts:327

sortOpaque

sortOpaque(a, b): number
An array sort for opaque elements
Parameters
- a: Drawable
  A renderable object for sorting
- b: Drawable
  A renderable object for sorting
Returns number
The number to determine relative position
- Defined in src/lib/core/Renderer.ts:549

sortTransparent

sortTransparent(a, b): number
An array sort for transparent elements
Parameters
- a: Drawable
  A renderable object for sorting
- b: Drawable
  A renderable object for sorting
Returns number
The number to determine relative position
- Defined in src/lib/core/Renderer.ts:567

sortUI

sortUI(a, b): number
An array sort for UI (no depth) elements
Parameters
- a: Drawable
  A renderable object for sorting
- b: Drawable
  A renderable object for sorting
Returns number
The number to determine relative position
- Defined in src/lib/core/Renderer.ts:584

Class Renderer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Renderer

Properties

alpha

Default

autoClear

Default

bindVertexArray

colour

Default

createVertexArray

currentGeometry

currentProgram

deleteVertexArray

depth

Default

dpr

Default

drawArraysInstanced

drawBuffers

drawElementsInstanced

extensions

gl

isWebgl2

parameters

premultipliedAlpha

Default

state

stencil

Default

vertexAttribDivisor

Accessors

activeTexture

Returns number

Parameters

Returns void

cullFace

Returns null | number

Parameters

Returns void

depthFunc

Returns null | number

Parameters

Returns void

depthMask

Returns boolean

Parameters

Returns void

dimensions

Returns Vec2

Parameters

Returns void

frontFace

Returns null | number

Parameters

Returns void

Methods

bindFramebuffer

Parameters

Optionalbuffer?: null | WebGLFramebuffer

Optionaltarget?: number

Returns void

disable

Parameters

Returns void

enable

Parameters

Returns void

getExtension

Parameters

Returns any

getRenderList

`Optional`buffer?: null | WebGLFramebuffer

`Optional`target?: number

`Optional`camera?: Camera