Class Buffer

Buffer base class, which can be an array of vertex buffers or an array of index buffers.

Hierarchy

Buffer

Index

Constructors

constructor

new Buffer(gl: WebGLRenderingContext, type: BufferBindFlag, byteLength: number, bufferUsage?: BufferUsage): Buffer
Create Buffer.
Parameters
- gl: WebGLRenderingContext
  
  WebGLRenderingContext
- type: BufferBindFlag
  
  Buffer binding flag
- byteLength: number
  
  Byte length
- Optional bufferUsage: BufferUsage
  
  Buffer usage
Returns Buffer
- Defined in core/graphic/Buffer.ts:48
new Buffer(gl: WebGLRenderingContext, type: BufferBindFlag, data: ArrayBufferView | ArrayBuffer, bufferUsage?: BufferUsage): Buffer
Create Buffer.
Parameters
- gl: WebGLRenderingContext
  
  WebGLRenderingContext
- type: BufferBindFlag
  
  Buffer binding flag
- data: ArrayBufferView | ArrayBuffer
  
  Byte
- Optional bufferUsage: BufferUsage
  
  Buffer usage
Returns Buffer
- Defined in core/graphic/Buffer.ts:57

Properties

`Private` _bufferUsage

_bufferUsage: BufferUsage

`Private` _byteLength

_byteLength: number

_gl

_gl: WebGLRenderingContext

_glBindTarget

_glBindTarget: number

_glBufferUsage

_glBufferUsage: number

_nativeBuffer

_nativeBuffer: WebGLBuffer

`Private` _type

_type: BufferBindFlag

Accessors

bufferUsage

get bufferUsage(): BufferUsage
Buffer usage.

Returns BufferUsage
- Defined in core/graphic/Buffer.ts:37

byteLength

get byteLength(): number
Byte length.

Returns number
- Defined in core/graphic/Buffer.ts:30

type

get type(): BufferBindFlag
Buffer binding flag.

Returns BufferBindFlag
- Defined in core/graphic/Buffer.ts:23

Methods

bind

bind(): void
Bind buffer.

Returns void
- Defined in core/graphic/Buffer.ts:95

getData

getData(data: ArrayBufferView): void
Get buffer data.
Parameters
- data: ArrayBufferView
  
  Output buffer data
Returns void
- Defined in core/graphic/Buffer.ts:164
getData(data: ArrayBufferView, bufferByteOffset: number): void
Get buffer data.
Parameters
- data: ArrayBufferView
  
  Output buffer data
- bufferByteOffset: number
  
  Buffer byte offset
Returns void
- Defined in core/graphic/Buffer.ts:171
getData(data: ArrayBufferView, bufferByteOffset: number, dataOffset: number, dataLength: number): void
Get buffer data.
Parameters
- data: ArrayBufferView
  
  Output buffer data
- bufferByteOffset: number
  
  Buffer byte offset
- dataOffset: number
  
  Output data offset
- dataLength: number
  
  Output data length
Returns void
- Defined in core/graphic/Buffer.ts:180

setData

setData(data: ArrayBufferView | ArrayBuffer): void
Set buffer data.
Parameters
- data: ArrayBufferView | ArrayBuffer
  
  Input buffer data
Returns void
- Defined in core/graphic/Buffer.ts:104
setData(data: ArrayBufferView | ArrayBuffer, bufferByteOffset: number): void
Set buffer data.
Parameters
- data: ArrayBufferView | ArrayBuffer
  
  Input buffer data
- bufferByteOffset: number
  
  buffer byte offset
Returns void
- Defined in core/graphic/Buffer.ts:111
setData(data: ArrayBufferView | ArrayBuffer, bufferByteOffset: number, dataOffset: number, dataLength?: number): void
Set buffer data.
Parameters
- data: ArrayBufferView | ArrayBuffer
  
  Input buffer data
- bufferByteOffset: number
  
  Buffer byte offset
- dataOffset: number
  
  Buffer byte offset
- Optional dataLength: number
  
  Data length
Returns void
- Defined in core/graphic/Buffer.ts:120
setData(data: ArrayBufferView | ArrayBuffer, bufferByteOffset: number, dataOffset: number, dataLength: number): void
Set buffer data.
Parameters
- data: ArrayBufferView | ArrayBuffer
  
  Input buffer data
- bufferByteOffset: number
  
  Buffer byte offset
- dataOffset: number
  
  Buffer byte offset
- dataLength: number
  
  Data length
Returns void
- Defined in core/graphic/Buffer.ts:130

Class Buffer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

gl: WebGLRenderingContext

type: BufferBindFlag

byteLength: number

Optional bufferUsage: BufferUsage

Returns Buffer

Parameters

gl: WebGLRenderingContext

type: BufferBindFlag

data: ArrayBufferView | ArrayBuffer

Optional bufferUsage: BufferUsage

Returns Buffer

Properties

Private _bufferUsage

Private _byteLength

_gl

_glBindTarget

_glBufferUsage

_nativeBuffer

Private _type

Accessors

bufferUsage

Returns BufferUsage

byteLength

Returns number

type

Returns BufferBindFlag

Methods

bind

Returns void

getData

Parameters

data: ArrayBufferView

Returns void

Parameters

data: ArrayBufferView

bufferByteOffset: number

Returns void

Parameters

data: ArrayBufferView

bufferByteOffset: number

dataOffset: number

dataLength: number

Returns void

setData

Parameters

data: ArrayBufferView | ArrayBuffer

Returns void

Parameters

data: ArrayBufferView | ArrayBuffer

bufferByteOffset: number

Returns void

Parameters

data: ArrayBufferView | ArrayBuffer

bufferByteOffset: number

dataOffset: number

Optional dataLength: number

Returns void

Parameters

data: ArrayBufferView | ArrayBuffer

bufferByteOffset: number

dataOffset: number

dataLength: number

Returns void

Settings

Member Visibility

Theme

`Optional` bufferUsage: BufferUsage

`Optional` bufferUsage: BufferUsage

`Private` _bufferUsage

`Private` _byteLength

`Private` _type

`Optional` dataLength: number