@dfdao/renderer v6.7.31

@dfdao/renderer

Table of contents

Classes

• AttribArray
• AttribManager
• EngineUtils
• GameGLManager
• GenericRenderer
• ProgramUtils
• Renderer
• ShaderMixins
• SpriteRenderer
• UIRenderer
• WebGLManager

Interfaces

• Attributes
• EngineProgramDefinition
• RendererGameContext
• Uniforms

Type aliases

• AttribData
• AttribManagers
• AttributeSetters
• GLArray
• ProgramInfo
• UniformData
• UniformLocs
• UniformSetter
• UniformSetters

Variables

• engineConsts

Functions

• getUniformSetter
• glsl

Classes

AttribArray

• AttribArray: Class AttribArray

Helper class - essentially an implementation of ArrayList from Java, but using typed JS Arrays so that we can efficiently write our WebGL data without converting.

AttribManager

• AttribManager: Class AttribManager

Responsible for queuing data about a webgl attribute and then writing to it. Does this by maintaining a persistent AttribArray and WebGLBuffer reference, and then calling bufferData on n vertices at a time. Allows us to upload whole arrays of objects at once, providing speed boost.

EngineUtils

• EngineUtils: Class EngineUtils

GameGLManager

• GameGLManager: Class GameGLManager

GenericRenderer

• GenericRenderer: Class GenericRenderer<T, U>

Takes in a gl context, program sources (frag and vert shader), and data about attribs / uniforms and provides:

• attrib managers
• uniform setters
• skeleton code for rendering in our engine via flush()

Type parameters

ProgramUtils

• ProgramUtils: Class ProgramUtils

Renderer

• Renderer: Class Renderer

ShaderMixins

• ShaderMixins: Class ShaderMixins

these are 'includes' that you can add into shader template strings as in ${include}

SpriteRenderer

• SpriteRenderer: Class SpriteRenderer

UIRenderer

• UIRenderer: Class UIRenderer

WebGLManager

• WebGLManager: Class WebGLManager

Interfaces

Attributes

• Attributes: Interface Attributes

EngineProgramDefinition

• EngineProgramDefinition: Interface EngineProgramDefinition

An object that describes all of the necessary data to create and manage this program within the renderer.

RendererGameContext

• RendererGameContext: Interface RendererGameContext

Uniforms

• Uniforms: Interface Uniforms

Type aliases

AttribData

Ƭ AttribData: Object

Index signature

▪ key: string: AttribProps

AttribManagers

Ƭ AttribManagers: { [k in keyof T"attribs"]: AttribManager }

Type parameters

AttributeSetters

Ƭ AttributeSetters: { key in keyof U: Function }

Type parameters

GLArray

Ƭ GLArray: Float32Array | Uint8Array

ProgramInfo

Ƭ ProgramInfo: Object

Type declaration

UniformData

Ƭ UniformData: Object

Index signature

▪ key: string: UniformProps

UniformLocs

Ƭ UniformLocs: { [k in keyof T"uniforms"]: WebGLUniformLocation }

Type parameters

UniformSetter

Ƭ UniformSetter: Function

Type declaration

▸ (el): void

Parameters

Returns

void

UniformSetters

Ƭ UniformSetters: { [k in keyof T"uniforms"]: UniformSetter }

Type parameters

Variables

engineConsts

• engineConsts: Object

Type declaration

Functions

getUniformSetter

▸ getUniformSetter(gl, loc, props): UniformSetter

Create a setter which writes the given uniform specified by props to loc. Note that this function does not call gl.useProgram().

Parameters

Returns

UniformSetter

glsl

▸ Const glsl(arr, ...args): string

Parameters

Returns

string