Class GPUBufferInformation

Descriptor structure used for initialization of a GPUBuffer.

Index

Constructors

Properties

_elementCount _elementSize _format _type _usage

Accessors

elementCount elementSize format type usage

Methods

assign clone isEqual isEqual

Constructors

constructor

new GPUBufferInformation(
    elementCount?: number,
    elementSize?: number,
    type?: EnumValue<GPUBufferType>,
    format?: EnumValue<GPUBufferFormat>,
    usage?: EnumValue<GPUBufferUsage>,
): GPUBufferInformation
Parameters
- OptionalelementCount: number
- OptionalelementSize: number
- Optionaltype: EnumValue<GPUBufferType>
- Optionalformat: EnumValue<GPUBufferFormat>
- Optionalusage: EnumValue<GPUBufferUsage>
Returns GPUBufferInformation

Properties

`Protected`_elementCount

_elementCount: number

`Protected`_elementSize

_elementSize: number

`Protected`_format

_format: EnumValue<GPUBufferFormat>

`Protected`_type

_type: EnumValue<GPUBufferType>

`Protected`_usage

_usage: EnumValue<GPUBufferUsage>

Accessors

elementCount

get elementCount(): number

Number of elements in the buffer.

Returns number
set elementCount(value: number): void
Parameters
- value: number
Returns void

elementSize

get elementSize(): number

Size of each individual element in the buffer, in bytes. Only needed if using non-standard buffer. If using standard buffers element size is calculated from format and this must be zero.

Returns number
set elementSize(value: number): void
Parameters
- value: number
Returns void

format

get format(): EnumValue<GPUBufferFormat>

Format if the data in the buffer. Only relevant for standard buffers, must be Unknown otherwise.

Returns EnumValue<GPUBufferFormat>
set format(value: EnumValue<GPUBufferFormat>): void
Parameters
- value: EnumValue<GPUBufferFormat>
Returns void

type

get type(): EnumValue<GPUBufferType>

Type of the buffer. Determines how is buffer seen by the GPU program and in what ways can it be used.

Returns EnumValue<GPUBufferType>
set type(value: EnumValue<GPUBufferType>): void
Parameters
- value: EnumValue<GPUBufferType>
Returns void

usage

get usage(): EnumValue<GPUBufferUsage>

Usage that tells the hardware how will be buffer be used.

Returns EnumValue<GPUBufferUsage>
set usage(value: EnumValue<GPUBufferUsage>): void
Parameters
- value: EnumValue<GPUBufferUsage>
Returns void

Methods

assign

assign(other: Immutable<GPUBufferInformation>): GPUBufferInformation
Copies all properties defined by the prototype of GPUBufferInformation from other to this instance.
Parameters
- other: Immutable<GPUBufferInformation>
Returns GPUBufferInformation

clone

clone(): GPUBufferInformation

Clones this instance and returns a new GPUBufferInformation with identical values.

Returns GPUBufferInformation

isEqual

isEqual(
this: Immutable<GPUBufferInformation>,
other: Immutable<GPUBufferInformation>,
): boolean
Determines if this GPUBufferInformation instance is equal to the other instance.
Parameters
- this: Immutable<GPUBufferInformation>
- other: Immutable<GPUBufferInformation>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<GPUBufferInformation>,
rhs: Immutable<GPUBufferInformation>,
): boolean
Determines if both GPUBufferInformation instances are equal.
Parameters
- lhs: Immutable<GPUBufferInformation>
- rhs: Immutable<GPUBufferInformation>
Returns boolean