Class Buffer

GFX buffer.

Hierarchy

Obj
- Buffer

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

newBuffer(device: Device): Buffer

Overrides Obj.constructor
- Defined in cocos/core/gfx/buffer.ts:157
Parameters
- device: Device
Returns Buffer

Properties

Protected _bakcupBuffer

_bakcupBuffer: Uint8Array | null = null

Protected _count

_count: number = 0

Protected _device

_device: Device

Protected _flags

_flags: BufferFlags = BufferFlagBit.NONE

Protected _gfxType

_gfxType: ObjectType = ObjectType.UNKNOWN

Protected _indirectBuffer

_indirectBuffer: IndirectBuffer | null = null

Protected _isBufferView

_isBufferView: boolean = false

Protected _memUsage

_memUsage: MemoryUsage = MemoryUsageBit.NONE

Protected _size

_size: number = 0

Protected _stride

_stride: number = 1

Protected _usage

_usage: BufferUsage = BufferUsageBit.NONE

Accessors

backupBuffer

get backupBuffer(): Uint8Array | null

- Defined in cocos/core/gfx/buffer.ts:144
View of the back-up buffer, if specified.

Returns Uint8Array | null

count

get count(): number

- Defined in cocos/core/gfx/buffer.ts:132
Count of the buffer wrt. stride.

Returns number

flags

get flags(): BufferFlags

- Defined in cocos/core/gfx/buffer.ts:136
Returns BufferFlags

gfxType

get gfxType(): ObjectType

Inherited from Obj.gfxType
- Defined in cocos/core/gfx/define.ts:57
Returns ObjectType

memUsage

get memUsage(): MemoryUsage

- Defined in cocos/core/gfx/buffer.ts:108
Memory usage of the buffer.

Returns MemoryUsage

size

get size(): number

- Defined in cocos/core/gfx/buffer.ts:116
Size of the buffer.

Returns number

stride

get stride(): number

- Defined in cocos/core/gfx/buffer.ts:124
Stride of the buffer.

Returns number

usage

get usage(): BufferUsage

- Defined in cocos/core/gfx/buffer.ts:100
Usage type of the buffer.

Returns BufferUsage

Methods

Abstract destroy

destroy(): void

- Defined in cocos/core/gfx/buffer.ts:166
Returns void

Abstract initialize

initialize(info: BufferInfo | BufferViewInfo): boolean

- Defined in cocos/core/gfx/buffer.ts:164
Parameters
- info: BufferInfo | BufferViewInfo
Returns boolean

Abstract resize

resize(size: number): void

- Defined in cocos/core/gfx/buffer.ts:173
Resize the buffer.

Parameters
- size: number
  
  The new buffer size.
Returns void

Abstract update

update(buffer: BufferSource, size?: undefined | number): void

- Defined in cocos/core/gfx/buffer.ts:181
Update the buffer data.

Parameters
- buffer: BufferSource
  
  The new buffer data.
- Optional size: undefined | number
  
  Size in bytes to be updated.
Returns void

Generated using TypeDoc