API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPipelineContext

Class used to store and describe the pipeline context associated with an effect

Hierarchy

  • IPipelineContext

Index

Properties

Methods

Properties

isAsyncSearch playground for isAsync

isAsync: boolean

Gets a boolean indicating that this pipeline context is supporting asynchronous creating

isReadySearch playground for isReady

isReady: boolean

Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)

Methods

disposeSearch playground for dispose

  • dispose(): void

  • Releases the resources associated with the pipeline.

    Returns void

setArraySearch playground for setArray

  • setArray(uniformName: string, array: number[] | Float32Array): void

  • Sets an array on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • array: number[] | Float32Array

      array to be set.

    Returns void

setArray2Search playground for setArray2

  • setArray2(uniformName: string, array: number[] | Float32Array): void

  • Sets an array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)

    Parameters

    • uniformName: string

      Name of the variable.

    • array: number[] | Float32Array

      array to be set.

    Returns void

setArray3Search playground for setArray3

  • setArray3(uniformName: string, array: number[] | Float32Array): void

  • Sets an array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)

    Parameters

    • uniformName: string

      Name of the variable.

    • array: number[] | Float32Array

      array to be set.

    Returns void

setArray4Search playground for setArray4

  • setArray4(uniformName: string, array: number[] | Float32Array): void

  • Sets an array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)

    Parameters

    • uniformName: string

      Name of the variable.

    • array: number[] | Float32Array

      array to be set.

    Returns void

setColor3Search playground for setColor3

  • setColor3(uniformName: string, color3: IColor3Like): void

  • Sets a Color3 on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • color3: IColor3Like

      Value to be set.

    Returns void

setColor4Search playground for setColor4

  • setColor4(uniformName: string, color3: IColor3Like, alpha: number): void

  • Sets a Color4 on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • color3: IColor3Like

      Value to be set.

    • alpha: number

      Alpha value to be set.

    Returns void

setDirectColor4Search playground for setDirectColor4

  • setDirectColor4(uniformName: string, color4: IColor4Like): void

  • Sets a Color4 on a uniform variable

    Parameters

    • uniformName: string

      defines the name of the variable

    • color4: IColor4Like

      defines the value to be set

    Returns void

setFloatSearch playground for setFloat

  • setFloat(uniformName: string, value: number): void

  • Sets a float on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • value: number

      value to be set.

    Returns void

setFloat2Search playground for setFloat2

  • setFloat2(uniformName: string, x: number, y: number): void

  • Sets a float2 on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • x: number

      First float in float2.

    • y: number

      Second float in float2.

    Returns void

setFloat3Search playground for setFloat3

  • setFloat3(uniformName: string, x: number, y: number, z: number): void

  • Sets a float3 on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • x: number

      First float in float3.

    • y: number

      Second float in float3.

    • z: number

      Third float in float3.

    Returns void

setFloat4Search playground for setFloat4

  • setFloat4(uniformName: string, x: number, y: number, z: number, w: number): void

  • Sets a float4 on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • x: number

      First float in float4.

    • y: number

      Second float in float4.

    • z: number

      Third float in float4.

    • w: number

      Fourth float in float4.

    Returns void

setIntSearch playground for setInt

  • setInt(uniformName: string, value: number): void

  • Sets an integer value on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • value: number

      Value to be set.

    Returns void

setInt2Search playground for setInt2

  • setInt2(uniformName: string, x: number, y: number): void

  • Sets an int2 value on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • x: number

      First int in int2.

    • y: number

      Second int in int2.

    Returns void

setInt3Search playground for setInt3

  • setInt3(uniformName: string, x: number, y: number, z: number): void

  • Sets an int3 value on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • x: number

      First int in int3.

    • y: number

      Second int in int3.

    • z: number

      Third int in int3.

    Returns void

setInt4Search playground for setInt4

  • setInt4(uniformName: string, x: number, y: number, z: number, w: number): void

  • Sets an int4 value on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • x: number

      First int in int4.

    • y: number

      Second int in int4.

    • z: number

      Third int in int4.

    • w: number

      Fourth int in int4.

    Returns void

setIntArraySearch playground for setIntArray

  • setIntArray(uniformName: string, array: Int32Array): void

  • Sets an int array on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • array: Int32Array

      array to be set.

    Returns void

setIntArray2Search playground for setIntArray2

  • setIntArray2(uniformName: string, array: Int32Array): void

  • Sets an int array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)

    Parameters

    • uniformName: string

      Name of the variable.

    • array: Int32Array

      array to be set.

    Returns void

setIntArray3Search playground for setIntArray3

  • setIntArray3(uniformName: string, array: Int32Array): void

  • Sets an int array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)

    Parameters

    • uniformName: string

      Name of the variable.

    • array: Int32Array

      array to be set.

    Returns void

setIntArray4Search playground for setIntArray4

  • setIntArray4(uniformName: string, array: Int32Array): void

  • Sets an int array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)

    Parameters

    • uniformName: string

      Name of the variable.

    • array: Int32Array

      array to be set.

    Returns void

setMatricesSearch playground for setMatrices

  • setMatrices(uniformName: string, matrices: Float32Array): void

  • Sets matrices on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • matrices: Float32Array

      matrices to be set.

    Returns void

setMatrixSearch playground for setMatrix

  • setMatrix(uniformName: string, matrix: IMatrixLike): void

  • Sets matrix on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • matrix: IMatrixLike

      matrix to be set.

    Returns void

setMatrix2x2Search playground for setMatrix2x2

  • setMatrix2x2(uniformName: string, matrix: Float32Array): void

  • Sets a 2x2 matrix on a uniform variable. (Specified as [1,2,3,4] will result in [1,2][3,4] matrix)

    Parameters

    • uniformName: string

      Name of the variable.

    • matrix: Float32Array

      matrix to be set.

    Returns void

setMatrix3x3Search playground for setMatrix3x3

  • setMatrix3x3(uniformName: string, matrix: Float32Array): void

  • Sets a 3x3 matrix on a uniform variable. (Specified as [1,2,3,4,5,6,7,8,9] will result in [1,2,3][4,5,6][7,8,9] matrix)

    Parameters

    • uniformName: string

      Name of the variable.

    • matrix: Float32Array

      matrix to be set.

    Returns void

setQuaternionSearch playground for setQuaternion

  • Sets a Quaternion on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • quaternion: IQuaternionLike

      Value to be set.

    Returns void

setVector2Search playground for setVector2

  • setVector2(uniformName: string, vector2: IVector2Like): void

  • Sets a Vector2 on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • vector2: IVector2Like

      vector2 to be set.

    Returns void

setVector3Search playground for setVector3

  • setVector3(uniformName: string, vector3: IVector3Like): void

  • Sets a Vector3 on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • vector3: IVector3Like

      Value to be set.

    Returns void

setVector4Search playground for setVector4

  • setVector4(uniformName: string, vector4: IVector4Like): void

  • Sets a Vector4 on a uniform variable.

    Parameters

    • uniformName: string

      Name of the variable.

    • vector4: IVector4Like

      Value to be set.

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method