Class Vao

A collection of attribute state; a vertex attribute array.

See

Hierarchy

Vao

Index

Constructors

Properties

attributesPrivate context elementArrayBuffer internal program

Accessors

attributes indices

Methods

addAttribute bind draw with bind getBoundVertexArrayObject unbind

Constructors

constructor

new Vao(program, attributes?, indices?): Vao
Creates a vertex array object.
Parameters
- program: Program
  
  The program that the VAO is used with.
- attributes: BufferInfo[] = []
  
  The attributes associated with the VAO.
- Optional indices: UintTypedArray
  
  The indices to supply to the element array buffer of this VAO if the data should be indexed.
Returns Vao
- Defined in src/core/Vao.ts:60

Properties

`Private` attributesPrivate

attributesPrivate: BufferInfo[]

The attributes associated with this VAO.

`Readonly` context

context: Context

The rendering context of this VAO.

`Private` elementArrayBuffer

elementArrayBuffer: undefined | Buffer

The element array buffer of this VAO if its data is indexed.

`Readonly` internal

internal: WebGLVertexArrayObject

The WebGL API interface of this VAO.

`Readonly` program

program: Program

The program that this VAO is used with.

Accessors

attributes

get attributes(): readonly BufferInfo[]
The attributes associated with this VAO.

Returns readonly BufferInfo[]
- Defined in src/core/Vao.ts:96

indices

get indices(): undefined | UintTypedArray
The indices in the element array buffer of this VAO if the data is indexed.

Returns undefined | UintTypedArray
- Defined in src/core/Vao.ts:107
set indices(value): void
The indices in the element array buffer of this VAO if the data is indexed.
Parameters
- value: undefined | UintTypedArray
Returns void
- Defined in src/core/Vao.ts:116

Methods

addAttribute

addAttribute(attribute): void
Adds an attribute to this VAO.
Parameters
- attribute: BufferInfo
  
  The attribute to add.
Returns void
- Defined in src/core/Vao.ts:159

bind

bind(): void
Makes this the active VAO.

Returns void
- Defined in src/core/Vao.ts:134

draw

draw(uniforms?, primitive?, offset?): void
Rasterizes the vertex data stored in this VAO.
Parameters
- Optional uniforms: UniformSource
  
  A map of uniform variable names to their values to use when rasterizing.
- primitive: Primitive = Primitive.TRIANGLES
  
  The type of primitive to rasterize.
- offset: number = 0
  
  The number of elements to skip when rasterizing arrays.
Returns void
- Defined in src/core/Vao.ts:173

with

with<T>(f): T
Executes the given function with this vertex array object bound, then re-binds the previously-bound vertex array object.
Type Parameters
- T
Parameters
- f: ((vao) => T)
  
  The function to execute.
  - - (vao): T
    - Parameters
      
      vao: Vao
      
      Returns T
Returns T
The return value of the executed function.
- Defined in src/core/Vao.ts:145

`Static` `Private` bind

bind(context, vao): void
Binds the given renderbuffer.
Parameters
- context: Context
  
  The rendering context.
- vao: null | WebGLVertexArrayObject
Returns void
- Defined in src/core/Vao.ts:45

`Static` `Private` getBoundVertexArrayObject

getBoundVertexArrayObject(context): null | WebGLVertexArrayObject
Gets the currently-bound vertex array object.
Parameters
- context: Context
  
  The rendering context.
Returns null | WebGLVertexArrayObject
The vertex array object.
- Defined in src/core/Vao.ts:33

`Static` unbind

unbind(context): void
Unbinds all vertex array objects from the given rendering context.
Parameters
- context: Context
  
  The rendering context.
Returns void
- Defined in src/core/Vao.ts:23

Generated using TypeDoc