Class UniformBuffer<Schema>

constructor

• new UniformBuffer<
      Schema extends
          Readonly<Record<string, Std140Type | Std140FieldDefinition>> = Readonly<
          Record<string, Std140Type | Std140FieldDefinition>,
      >,
  >(
      layout: Std140Layout<Schema>,
      values?: Partial<Std140Values<Schema>>,
  ): UniformBuffer<Schema>

  Type Parameters

  • Schema extends Readonly<Record<string, Std140Type | Std140FieldDefinition>> = Readonly<Record<string, Std140Type | Std140FieldDefinition>>

  Parameters

  • layout: Std140Layout<Schema>
  • values: Partial<Std140Values<Schema>> = {}

  Returns UniformBuffer<Schema>

ReadonlyclassName

ReadonlyisUniformBuffer

Readonlylayout

byteLength

• get byteLength(): number

  Returns number

data

• get data(): ArrayBuffer

  data

  Returns ArrayBuffer

• set data(data: ArrayBuffer): void

  data

  Parameters

  • data: ArrayBuffer

  Returns void

revision

• get revision(): number

  Monotonic CPU-data revision shared by WebGL2 and WebGPU upload caches.

  Returns number

getDirtyRangesSince

• getDirtyRangesSince(revision: number): readonly UniformBufferDirtyRange[] | null

  Return retained writes newer than a backend-local revision. null means the consumer fell behind the bounded history window and must upload the complete current buffer.

  Parameters

  • revision: number

  Returns readonly UniformBufferDirtyRange[] | null

markDirty

• markDirty(byteOffset?: number, byteLength?: number): this

  Mark externally mutated bytes for upload on every context using this buffer.

  Parameters

  • byteOffset: number = 0
  • byteLength: number = ...

  Returns this

range

• range(byteOffset: number, byteLength: number): UniformBufferRange

  Parameters

  • byteOffset: number
  • byteLength: number

  Returns UniformBufferRange

set

• set<Name extends string>(
      name: Name,
      value: Std140FieldValue<Schema[Name]>,
  ): this

  Pack and update a named field when this buffer was constructed from a std140 layout.

  Type Parameters

  • Name extends string

  Parameters

  • name: Name
  • value: Std140FieldValue<Schema[Name]>

  Returns this

write

• write(byteOffset: number, data: TypedArray): this

  Copy raw bytes into the backing store and enqueue the smallest possible GPU update.

  Parameters

  • byteOffset: number
  • data: TypedArray

  Returns this

StaticfromSchema

• fromSchema<
      const Schema extends
          Readonly<Record<string, Std140Type | Std140FieldDefinition>>,
  >(
      layout: Std140Layout<Schema>,
      values?: Partial<Std140Values<Schema>>,
  ): UniformBuffer<Schema>

  Type Parameters

  • const Schema extends Readonly<Record<string, Std140Type | Std140FieldDefinition>>

  Parameters

  • layout: Std140Layout<Schema>
  • values: Partial<Std140Values<Schema>> = {}

  Returns UniformBuffer<Schema>