Libraries.Game.Graphics.Shaders.Programs.ShaderProgramStrategy Documentation

This class is an interface used by the ShaderProgram class to handle the very different ways that shaders are used across different graphics libraries like OpenGL and Vulkan.

Inherits from: Libraries.Language.Object

Actions Documentation

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

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.

Parameters

Return

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

Example

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

Compile()

Dispose()

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

Parameters

Draw(Libraries.Game.Graphics.Drawable drawable)

Parameters

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, Libraries.Containers.Array<integer> vertexLocations)

Parameters

End()

Equals(Libraries.Language.Object object)

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

Parameters

Return

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

Example

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

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

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:

GetProgram()

Return

Libraries.Game.Graphics.Shaders.Programs.ShaderProgram

GetShaderIterator()

Return

Libraries.Containers.Iterator

IsCompiled()

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

boolean:

Reload()

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

Parameters

Render(Libraries.Game.Graphics.Renderable renderable)

Parameters

SetProgram(Libraries.Game.Graphics.Shaders.Programs.ShaderProgram program)

Parameters