Libraries.Game.Graphics.Shaders.ShaderProgram Documentation

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Add(Libraries.Game.Graphics.Shaders.Shader shader)The current shader mapping that is being use
AddOrderedVertexInput(text name)
Begin()
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Compile()
DisableVertexInput(integer inputID)
DisableVertexInput(text inputName)
Dispose()
Draw(Libraries.Game.Graphics.Drawable drawable, integer startIndex, integer totalIndices)
Draw(Libraries.Game.Graphics.Mesh mesh, Libraries.Game.Graphics.Camera camera, integer startIndex, integer totalIndices)
Draw(Libraries.Game.Graphics.Drawable drawable)
EnableVertexInput(text inputName)
EnableVertexInput(integer inputID)
End()
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetID()This action returns a unique ID representing this shader program.
GetIterator()
GetName()This action returns a unique ID representing this shader program.
GetOrderedVertexInputs()
GetShaderInputLocation(text name)
GetShaderInputNames()
GetShaderInputSize(text name)
GetShaderInputType(text name)
GetShaderMapping()
GetVertexInputLocation(text name)
GetVertexInputNames()
GetVertexInputSize(text name)
GetVertexInputType(text name)
HasShaderInput(text name)
HasVertexInput(text name)
Invalidate()
IsCompiled()
IsInvalidated()
Reload()
Remove(Libraries.Game.Graphics.Shaders.Shader shader)
Render(Libraries.Game.Graphics.Renderable renderable)
SetDefaultVertexInputValue(integer inputID, number x, number y, number z, number w)
SetDefaultVertexInputValue(integer inputID, number x)
SetDefaultVertexInputValue(text inputName, number x)
SetDefaultVertexInputValue(integer inputID, number x, number y, number z)
SetDefaultVertexInputValue(text inputName, number x, number y, number z)
SetDefaultVertexInputValue(integer inputID, number x, number y)
SetDefaultVertexInputValue(text inputName, number x, number y)
SetDefaultVertexInputValue(text inputName, number x, number y, number z, number w)
SetName(text name)
SetShaderInput(integer uniformID, boolean value)
SetShaderInput(integer uniformID, number value1, number value2, number value3)
SetShaderInput(text name, number value1, number value2)
SetShaderInput(text name, boolean value)
SetShaderInput(text name, integer value1, integer value2, integer value3)
SetShaderInput(integer uniformID, integer value)
SetShaderInput(integer uniformID, integer value1, integer value2, integer value3, integer value4)
SetShaderInput(integer uniformID, Libraries.Game.Graphics.Color color)
SetShaderInput(text name, number value1, number value2, number value3, number value4)
SetShaderInput(text name, integer value)
SetShaderInput(integer uniformID, integer value1, integer value2)
SetShaderInput(text name, number value)
SetShaderInput(integer uniformID, number value1, number value2)
SetShaderInput(integer uniformID, number value1, number value2, number value3, number value4)
SetShaderInput(integer uniformID, Libraries.Compute.Vector3 values)
SetShaderInput(integer uniformID, Libraries.Compute.Vector2 values)
SetShaderInput(text name, integer value1, integer value2, integer value3, integer value4)
SetShaderInput(integer uniformID, integer value1, integer value2, integer value3)
SetShaderInput(text name, number value1, number value2, number value3)
SetShaderInput(text name, Libraries.Game.Graphics.Color color)
SetShaderInput(integer uniformID, number value)
SetShaderInput(text name, Libraries.Compute.Vector2 values)
SetShaderInput(text name, Libraries.Compute.Vector3 values)
SetShaderInput(text name, integer value1, integer value2)
SetShaderInputArray(text name, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)
SetShaderInputArray(integer uniformID, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)
SetShaderInputMatrix(integer uniformID, Libraries.Compute.Matrix3 matrix, boolean transpose)
SetShaderInputMatrix(text name, Libraries.Compute.Matrix3 matrix)
SetShaderInputMatrix(text name, Libraries.Compute.Matrix4 matrix)
SetShaderInputMatrix(integer uniformID, Libraries.Compute.Matrix4 matrix)
SetShaderInputMatrix(integer uniformID, Libraries.Compute.Matrix3 matrix)
SetShaderInputMatrix(text name, Libraries.Compute.Matrix3 matrix, boolean transpose)
SetShaderInputMatrix(text name, Libraries.Compute.Matrix4 matrix, boolean transpose)
SetShaderInputMatrix(integer uniformID, Libraries.Compute.Matrix4 matrix, boolean transpose)
SetShaderInputMatrix3(integer uniformID, Libraries.Containers.Number32BitArray matrix)
SetShaderInputMatrix3(integer uniformID, Libraries.Containers.Number32BitArray matrix, boolean transpose)
SetShaderInputMatrix4(integer uniformID, Libraries.Containers.Number32BitArray matrix, boolean transpose)
SetShaderInputMatrix4(integer uniformID, Libraries.Containers.Number32BitArray matrix)
SetShaderInputVector2Array(integer uniformID, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)
SetShaderInputVector2Array(text name, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)
SetShaderInputVector3Array(text name, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)
SetShaderInputVector3Array(integer uniformID, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)
SetShaderInputVector4Array(text name, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)
SetShaderInputVector4Array(integer uniformID, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)
SetShaderMapping(Libraries.Game.Graphics.Shaders.ShaderMapping shaderMapping)
SetVertexInput(text name, integer size, integer type, boolean normalize, integer stride, integer offset)
SetVertexInput(integer inputID, integer size, integer type, boolean normalize, integer stride, integer offset)

Actions Documentation

Add(Libraries.Game.Graphics.Shaders.Shader shader)

The current shader mapping that is being use

Parameters

AddOrderedVertexInput(text name)

Parameters

Begin()

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Compile()

DisableVertexInput(integer inputID)

Parameters

DisableVertexInput(text inputName)

Parameters

Dispose()

Draw(Libraries.Game.Graphics.Drawable drawable, integer startIndex, integer totalIndices)

Parameters

Draw(Libraries.Game.Graphics.Mesh mesh, Libraries.Game.Graphics.Camera camera, integer startIndex, integer totalIndices)

Parameters

Draw(Libraries.Game.Graphics.Drawable drawable)

Parameters

EnableVertexInput(text inputName)

Parameters

EnableVertexInput(integer inputID)

Parameters

End()

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetID()

This action returns a unique ID representing this shader program. This is provided by the rendering system once the program has been compiled. If this program hasn't been compiled yet, this value will be -1.

Return

integer:

GetIterator()

Return

Libraries.Containers.Iterator

GetName()

This action returns a unique ID representing this shader program. This is provided by the rendering system once the program has been compiled. If this program hasn't been compiled yet, this value will be -1.

Return

text:

GetOrderedVertexInputs()

Return

Libraries.Containers.Array

GetShaderInputLocation(text name)

Parameters

Return

integer

GetShaderInputNames()

Return

Libraries.Containers.Iterator

GetShaderInputSize(text name)

Parameters

Return

integer

GetShaderInputType(text name)

Parameters

Return

integer

GetShaderMapping()

Return

Libraries.Game.Graphics.Shaders.ShaderMapping

GetVertexInputLocation(text name)

Parameters

Return

integer

GetVertexInputNames()

Return

Libraries.Containers.Iterator

GetVertexInputSize(text name)

Parameters

Return

integer

GetVertexInputType(text name)

Parameters

Return

integer

HasShaderInput(text name)

Parameters

Return

boolean

HasVertexInput(text name)

Parameters

Return

boolean

Invalidate()

IsCompiled()

Return

boolean

IsInvalidated()

Return

boolean

Reload()

Remove(Libraries.Game.Graphics.Shaders.Shader shader)

Parameters

Render(Libraries.Game.Graphics.Renderable renderable)

Parameters

SetDefaultVertexInputValue(integer inputID, number x, number y, number z, number w)

Parameters

SetDefaultVertexInputValue(integer inputID, number x)

Parameters

SetDefaultVertexInputValue(text inputName, number x)

Parameters

SetDefaultVertexInputValue(integer inputID, number x, number y, number z)

Parameters

SetDefaultVertexInputValue(text inputName, number x, number y, number z)

Parameters

SetDefaultVertexInputValue(integer inputID, number x, number y)

Parameters

SetDefaultVertexInputValue(text inputName, number x, number y)

Parameters

SetDefaultVertexInputValue(text inputName, number x, number y, number z, number w)

Parameters

SetName(text name)

Parameters

SetShaderInput(integer uniformID, boolean value)

Parameters

SetShaderInput(integer uniformID, number value1, number value2, number value3)

Parameters

SetShaderInput(text name, number value1, number value2)

Parameters

SetShaderInput(text name, boolean value)

Parameters

SetShaderInput(text name, integer value1, integer value2, integer value3)

Parameters

SetShaderInput(integer uniformID, integer value)

Parameters

SetShaderInput(integer uniformID, integer value1, integer value2, integer value3, integer value4)

Parameters

SetShaderInput(integer uniformID, Libraries.Game.Graphics.Color color)

Parameters

SetShaderInput(text name, number value1, number value2, number value3, number value4)

Parameters

SetShaderInput(text name, integer value)

Parameters

SetShaderInput(integer uniformID, integer value1, integer value2)

Parameters

SetShaderInput(text name, number value)

Parameters

SetShaderInput(integer uniformID, number value1, number value2)

Parameters

SetShaderInput(integer uniformID, number value1, number value2, number value3, number value4)

Parameters

SetShaderInput(integer uniformID, Libraries.Compute.Vector3 values)

Parameters

SetShaderInput(integer uniformID, Libraries.Compute.Vector2 values)

Parameters

SetShaderInput(text name, integer value1, integer value2, integer value3, integer value4)

Parameters

SetShaderInput(integer uniformID, integer value1, integer value2, integer value3)

Parameters

SetShaderInput(text name, number value1, number value2, number value3)

Parameters

SetShaderInput(text name, Libraries.Game.Graphics.Color color)

Parameters

SetShaderInput(integer uniformID, number value)

Parameters

SetShaderInput(text name, Libraries.Compute.Vector2 values)

Parameters

SetShaderInput(text name, Libraries.Compute.Vector3 values)

Parameters

SetShaderInput(text name, integer value1, integer value2)

Parameters

SetShaderInputArray(text name, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)

Parameters

SetShaderInputArray(integer uniformID, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)

Parameters

SetShaderInputMatrix(integer uniformID, Libraries.Compute.Matrix3 matrix, boolean transpose)

Parameters

SetShaderInputMatrix(text name, Libraries.Compute.Matrix3 matrix)

Parameters

SetShaderInputMatrix(text name, Libraries.Compute.Matrix4 matrix)

Parameters

SetShaderInputMatrix(integer uniformID, Libraries.Compute.Matrix4 matrix)

Parameters

SetShaderInputMatrix(integer uniformID, Libraries.Compute.Matrix3 matrix)

Parameters

SetShaderInputMatrix(text name, Libraries.Compute.Matrix3 matrix, boolean transpose)

Parameters

SetShaderInputMatrix(text name, Libraries.Compute.Matrix4 matrix, boolean transpose)

Parameters

SetShaderInputMatrix(integer uniformID, Libraries.Compute.Matrix4 matrix, boolean transpose)

Parameters

SetShaderInputMatrix3(integer uniformID, Libraries.Containers.Number32BitArray matrix)

Parameters

SetShaderInputMatrix3(integer uniformID, Libraries.Containers.Number32BitArray matrix, boolean transpose)

Parameters

SetShaderInputMatrix4(integer uniformID, Libraries.Containers.Number32BitArray matrix, boolean transpose)

Parameters

SetShaderInputMatrix4(integer uniformID, Libraries.Containers.Number32BitArray matrix)

Parameters

SetShaderInputVector2Array(integer uniformID, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)

Parameters

SetShaderInputVector2Array(text name, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)

Parameters

SetShaderInputVector3Array(text name, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)

Parameters

SetShaderInputVector3Array(integer uniformID, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)

Parameters

SetShaderInputVector4Array(text name, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)

Parameters

SetShaderInputVector4Array(integer uniformID, Libraries.Containers.Number32BitArray values, integer startIndex, integer length)

Parameters

SetShaderMapping(Libraries.Game.Graphics.Shaders.ShaderMapping shaderMapping)

Parameters

SetVertexInput(text name, integer size, integer type, boolean normalize, integer stride, integer offset)

Parameters

SetVertexInput(integer inputID, integer size, integer type, boolean normalize, integer stride, integer offset)

Parameters