Options
All
  • Public
  • Public/Protected
  • All
Menu

API | Aura2D

Index

Type aliases

AttributeArray: { name: string; size: number }[]

Utility type representing an array of shader attribute specifications, denoting their names and sizes, used in defining VertexShaders

ClassType<T>: {}

Create a 'newable' type for the class T

Type parameters

  • T

Type declaration

    ControlScheme: "keyboard" | "mouse" | "both"

    Utility type denoting the Game's ControlScheme, utilised in Game configuration and InputManager event handling

    DeepPartial<T>: { [ K in keyof T]?: DeepPartial<T[K]> }

    Create a version of an object recursively making all properties optional

    Type parameters

    • T

    DeepRequired<T>: { [ K in keyof T]-?: DeepRequired<T[K]> }

    Create a version of an object recursively requiring all properties

    Type parameters

    • T

    Mutable<T>: { -readonly [ K in keyof T]: T[K] }

    Create a Mutable version of the class T by removing any readonly specifiers from its properties

    Type parameters

    • T

    UniformArray: { name: string; type: UniformType; variation: UniformVariation }[]

    Utility type representing an array of shader uniform specifications, used in defining VertexShaders and FragmentShaders

    Uniform 'variation' is a special field which determines both how often a uniform will vary, and how it can be retrieved by the Renderer

    Variables

    FragmentShaders: { BASIC: FragmentShader; COLOR_PER_VERTEX: FragmentShader; TEXTURE: FragmentShader; TEXTURE_COLORED: FragmentShader } = ...

    Type declaration

    Geometries: { CIRCLE: Geometry; F: Geometry; HEXAGON: Geometry; LINE: Geometry; OCTAGON: Geometry; PENTAGON: Geometry; POINT: Geometry; POLYGON: (vertexCount: number, name?: string) => Geometry; SQUARE: Geometry; TRIANGLE: Geometry; TRIANGLE_RIGHT_ANGLE: Geometry; Wireframe: { CIRCLE: Geometry; F: Geometry; HEXAGON: Geometry; OCTAGON: Geometry; PENTAGON: Geometry; POLYGON: (vertexCount: number, name?: string) => Geometry; SQUARE: Geometry; TRIANGLE: Geometry; TRIANGLE_RIGHT_ANGLE: Geometry } } = ...

    Type declaration

    ShaderPrograms: { BASIC: ShaderProgram; COLOR_PER_VERTEX: ShaderProgram; TEXTURE: ShaderProgram; TEXTURE_COLORED: ShaderProgram } = ...

    Type declaration

    VertexShaders: { BASIC: VertexShader; COLOR_PER_VERTEX: VertexShader; TEXTURE: VertexShader } = ...

    Type declaration