UniformBuffer | Babylon.js API documentation

Class UniformBuffer

Uniform buffer objects.

Handles blocks of uniform on the GPU.

If WebGL 2 is not available, this class falls back on traditional setUniformXXX calls.

For more information, please refer to : https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object

Constructors

constructor

new UniformBuffer(
    engine: AbstractEngine,
    data?: number[],
    dynamic?: boolean,
    name?: string,
    forceNoUniformBuffer?: boolean,
): UniformBuffer
Instantiates a new Uniform buffer objects.

Handles blocks of uniform on the GPU.

If WebGL 2 is not available, this class falls back on traditional setUniformXXX calls.

For more information, please refer to :
Parameters
- engine: AbstractEngine
  Define the engine the buffer is associated with
- Optionaldata: number[]
  Define the data contained in the buffer
- Optionaldynamic: boolean
  Define if the buffer is updatable
- Optionalname: string
  to assign to the buffer (debugging purpose)
- OptionalforceNoUniformBuffer: boolean
  define that this object must not rely on UBO objects
Returns UniformBuffer
See
https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69486

Properties

updateArray

updateArray: (name: string, array: number[]) => void

Lambda to Update an array of number in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateColor3

updateColor3: (name: string, color: IColor3Like, suffix?: string) => void

Lambda to Update vec3 of float from a Color in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateColor4

updateColor4: (
    name: string,
    color: IColor3Like,
    alpha: number,
    suffix?: string,
) => void

Lambda to Update vec4 of float from a Color in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateDirectColor4

updateDirectColor4: (name: string, color: IColor4Like, suffix?: string) => void

Lambda to Update vec4 of float from a Color in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateFloat

updateFloat: (name: string, x: number) => void

Lambda to Update a single float in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateFloat2

updateFloat2: (name: string, x: number, y: number, suffix?: string) => void

Lambda to Update a vec2 of float in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateFloat3

updateFloat3: (
    name: string,
    x: number,
    y: number,
    z: number,
    suffix?: string,
) => void

Lambda to Update a vec3 of float in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateFloat4

updateFloat4: (
    name: string,
    x: number,
    y: number,
    z: number,
    w: number,
    suffix?: string,
) => void

Lambda to Update a vec4 of float in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateFloatArray

updateFloatArray: (name: string, array: Float32Array) => void

Lambda to Update an array of float in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateInt

updateInt: (name: string, x: number, suffix?: string) => void

Lambda to Update a int a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateInt2

updateInt2: (name: string, x: number, y: number, suffix?: string) => void

Lambda to Update a vec2 of int in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateInt3

updateInt3: (
    name: string,
    x: number,
    y: number,
    z: number,
    suffix?: string,
) => void

Lambda to Update a vec3 of int in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateInt4

updateInt4: (
    name: string,
    x: number,
    y: number,
    z: number,
    w: number,
    suffix?: string,
) => void

Lambda to Update a vec4 of int in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateIntArray

updateIntArray: (name: string, array: Int32Array) => void

Lambda to Update an array of number in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateMatrices

updateMatrices: (name: string, mat: Float32Array) => void

Lambda to Update an array of 4x4 Matrix in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateMatrix

updateMatrix: (name: string, mat: IMatrixLike) => void

Lambda to Update a 4x4 Matrix in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateMatrix2x2

updateMatrix2x2: (name: string, matrix: Float32Array) => void

Lambda to Update a 2x2 Matrix in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateMatrix3x3

updateMatrix3x3: (name: string, matrix: Float32Array) => void

Lambda to Update a 3x3 Matrix in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateUInt

updateUInt: (name: string, x: number, suffix?: string) => void

Lambda to Update a unsigned int a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateUInt2

updateUInt2: (name: string, x: number, y: number, suffix?: string) => void

Lambda to Update a vec2 of unsigned int in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateUInt3

updateUInt3: (
    name: string,
    x: number,
    y: number,
    z: number,
    suffix?: string,
) => void

Lambda to Update a vec3 of unsigned int in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateUInt4

updateUInt4: (
    name: string,
    x: number,
    y: number,
    z: number,
    w: number,
    suffix?: string,
) => void

Lambda to Update a vec4 of unsigned int in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateUIntArray

updateUIntArray: (name: string, array: Uint32Array) => void

Lambda to Update an array of number in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateVector3

updateVector3: (name: string, vector: IVector3Like) => void

Lambda to Update vec3 of float from a Vector in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

updateVector4

updateVector4: (name: string, vector: IVector4Like) => void

Lambda to Update vec4 of float from a Vector in a uniform buffer. This is dynamic to allow compat with webgl 1 and 2. You will need to pass the name of the uniform as well as the value.

Accessors

currentEffect

get currentEffect(): Nullable<Effect>
Gets the current effect

Returns Nullable<Effect>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69597

isSync

get isSync(): boolean
Indicates if the WebGL underlying uniform buffer is in sync with the javascript cache data.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69496

name

get name(): string
Gets the name of this buffer

Returns string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69595

useUbo

get useUbo(): boolean
Indicates if the buffer is using the WebGL2 UBO implementation, or just falling back on setUniformXXX calls.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69491

Methods

addColor3

addColor3(name: string, color: IColor3Like): void
Adds a vec3 to the uniform buffer.
Parameters
- name: string
  Name of the uniform, as used in the uniform block in the shader.
- color: IColor3Like
  Define the vec3 from a Color
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69557

addColor4

addColor4(name: string, color: IColor3Like, alpha: number): void
Adds a vec4 to the uniform buffer.
Parameters
- name: string
  Name of the uniform, as used in the uniform block in the shader.
- color: IColor3Like
  Define the rgb components from a Color
- alpha: number
  Define the a component of the vec4
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69564

addFloat2

addFloat2(name: string, x: number, y: number): void
Adds a vec2 to the uniform buffer.
Parameters
- name: string
  Name of the uniform, as used in the uniform block in the shader.
- x: number
  Define the x component value of the vec2
- y: number
  Define the y component value of the vec2
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69543

addFloat3

addFloat3(name: string, x: number, y: number, z: number): void
Adds a vec3 to the uniform buffer.
Parameters
- name: string
  Name of the uniform, as used in the uniform block in the shader.
- x: number
  Define the x component value of the vec3
- y: number
  Define the y component value of the vec3
- z: number
  Define the z component value of the vec3
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69551

addMatrix

addMatrix(name: string, mat: IMatrixLike): void
Adds a Matrix 4x4 to the uniform buffer.
Parameters
- name: string
  Name of the uniform, as used in the uniform block in the shader.
- mat: IMatrixLike
  A 4x4 matrix.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69536

addMatrix2x2

addMatrix2x2(name: string): void
Adds a Matrix 2x2 to the uniform buffer.
Parameters
- name: string
  Name of the uniform, as used in the uniform block in the shader.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69580

addMatrix3x3

addMatrix3x3(name: string): void
Adds a Matrix 3x3 to the uniform buffer.
Parameters
- name: string
  Name of the uniform, as used in the uniform block in the shader.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69575

addUniform

addUniform(name: string, size: number | number[], arraySize?: number): void
Adds an uniform in the buffer. Warning : the subsequents calls of this function must be in the same order as declared in the shader for the layout to be correct ! The addUniform function only handles types like float, vec2, vec3, vec4, mat4, meaning size=1,2,3,4 or 16. It does not handle struct types.
Parameters
- name: string
  Name of the uniform, as used in the uniform block in the shader.
- size: number | number[]
  Data size, or data directly.
- OptionalarraySize: number
  The number of elements in the array, 0 if not an array.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69530

addVector3

addVector3(name: string, vector: IVector3Like): void
Adds a vec3 to the uniform buffer.
Parameters
- name: string
  Name of the uniform, as used in the uniform block in the shader.
- vector: IVector3Like
  Define the vec3 components from a Vector
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69570

bindTexture

bindTexture(name: string, texture: Nullable<InternalTexture>): void
Sets a sampler uniform on the effect.
Parameters
- name: string
  Define the name of the sampler.
- texture: Nullable<InternalTexture>
  Define the (internal) texture to set in the sampler
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69691

bindToEffect

bindToEffect(effect: Effect, name: string): void
Associates an effect to this uniform buffer
Parameters
- effect: Effect
  Define the effect to associate the buffer to
- name: string
  Name of the uniform block in the shader.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69703

bindUniformBuffer

bindUniformBuffer(): void
Binds the current (GPU) buffer to the effect

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69707

create

create(): void
Effectively creates the WebGL Uniform Buffer, once layout is completed with addUniform.

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69584

dispose

dispose(): void
Disposes the uniform buffer.

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69722

getBuffer

getBuffer(): Nullable<DataBuffer>
The underlying WebGL Uniform buffer.

Returns Nullable<DataBuffer>
the webgl buffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69513

getData

getData(): Float32Array
The data cache on JS side.

Returns Float32Array
the underlying data as a float array
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69508

isDynamic

isDynamic(): boolean
Indicates if the WebGL underlying uniform buffer is dynamic. Also, a dynamic UniformBuffer will disable cache verification and always update the underlying WebGL uniform buffer to the GPU.

Returns boolean
if Dynamic, otherwise false
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69503

setDataBuffer

setDataBuffer(dataBuffer: DataBuffer): boolean
Sets the current state of the class (_bufferIndex, _buffer) to point to the data buffer passed in parameter if this buffer is one of the buffers handled by the class (meaning if it can be found in the _buffers array) This method is meant to be able to update a buffer at any time: just call setDataBuffer to set the class in the right state, call some updateXXX methods and then call udpate() => that will update the GPU buffer on the graphic card
Parameters
- dataBuffer: DataBuffer
  buffer to look for
Returns boolean
true if the buffer has been found and the class internal state points to it, else false
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69718

setTexture

setTexture(name: string, texture: Nullable<ThinTexture>): void
Sets a sampler uniform on the effect.
Parameters
- name: string
  Define the name of the sampler.
- texture: Nullable<ThinTexture>
  Define the texture to set in the sampler
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69679

setTextureArray

setTextureArray(name: string, textures: ThinTexture[]): void
Sets an array of sampler uniforms on the effect.
Parameters
- name: string
  Define the name of uniform.
- textures: ThinTexture[]
  Define the textures to set in the array of samplers
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69685

unbindEffect

unbindEffect(): void
Dissociates the current effect from this uniform buffer

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69711

update

update(): void
Updates the WebGL Uniform Buffer on the GPU. If the dynamic flag is set to true, no cache comparison is done. Otherwise, the buffer will be updated only if the cache differs.

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69605

updateUniform

updateUniform(uniformName: string, data: FloatArray, size: number): void
Updates the value of an uniform. The update method must be called afterwards to make it effective in the GPU.
Parameters
- uniformName: string
  Define the name of the uniform, as used in the uniform block in the shader.
- data: FloatArray
  Define the flattened data
- size: number
  Define the size of the data.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69614

updateUniformArray

updateUniformArray(uniformName: string, data: FloatArray, size: number): void
Updates the value of an uniform. The update method must be called afterwards to make it effective in the GPU.
Parameters
- uniformName: string
  Define the name of the uniform, as used in the uniform block in the shader.
- data: FloatArray
  Define the flattened data
- size: number
  Define the size of the data.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69621

updateUniformDirectly

updateUniformDirectly(uniformName: string, data: FloatArray): void
Directly updates the value of the uniform in the cache AND on the GPU.
Parameters
- uniformName: string
  Define the name of the uniform, as used in the uniform block in the shader.
- data: FloatArray
  Define the flattened data
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:69697

Class UniformBuffer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UniformBuffer

See

Properties

updateArray

updateColor3

updateColor4

updateDirectColor4

updateFloat

updateFloat2

updateFloat3

updateFloat4

updateFloatArray

updateInt

updateInt2

updateInt3

updateInt4

updateIntArray

updateMatrices

updateMatrix

updateMatrix2x2

updateMatrix3x3

updateUInt

updateUInt2

updateUInt3

updateUInt4

updateUIntArray

updateVector3

updateVector4

Accessors

currentEffect

Returns Nullable<Effect>

isSync

Returns boolean

name

Returns string

useUbo

Returns boolean

Methods

addColor3

Parameters

Returns void

addColor4

Parameters

Returns void

addFloat2

Parameters

Returns void

addFloat3

Parameters

Returns void

addMatrix

Parameters

Returns void

addMatrix2x2

Parameters

Returns void

addMatrix3x3

Parameters

Returns void

addUniform

Parameters

Returns void

addVector3

Parameters

Returns void

bindTexture

Parameters

Returns void

bindToEffect

Parameters

Returns void