Libraries.Game.Graphics.Shaders.Shader Documentation

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
integer GEOMETRY_SHADERThis type constant is used to indicate that the shader is a geometry shader. This shader step is optiona
integer TESSELLATION_EVALUATION_SHADERThis type constant is used to indicate that the shader is a tessellation evaluation shader. This shader step is optional. If used, this should follow after a tessellation control shader in a shader progra
integer TESSELLATION_CONTROL_SHADERThis type constant is used to indicate that the shader is a tessellation control shader. This shader step is optional. If used, this should precede a tessellation evaluation shader in a shader progra
integer FRAGMENT_SHADERThis type constant is used to indicate that the shader is a fragment shader. Every shader program must have a fragment shader as its final shader ste
integer VERTEX_SHADERThis type constant is used to indicate that the shader is a vertex shader. Every shader program must have a vertex shader as its first shader ste

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Compile()
Dispose()
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetCode()
GetHashCode()This action gets the hash code for an object.
GetID()
GetName()
GetOpenGLVersion()This action takes platform into account and returns a default version of OpenGL's number to be placed at the top of a shader.
GetType()
Invalidate()
IsCompiled()
IsInvalidated()
Reload()This action takes platform into account and returns a default version of OpenGL's number to be placed at the top of a shader.
SetCode(text code)
SetName(text name)
SetType(integer type)

Actions Documentation

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()

Dispose()

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.

GetCode()

Return

text

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()

Return

integer

GetName()

Return

text

GetOpenGLVersion()

This action takes platform into account and returns a default version of OpenGL's number to be placed at the top of a shader. For shaders not using OpenGL, this action does not provide useful information. The version number is calculated by Quorum, not the graphics hardware.

Return

text:

GetType()

Return

integer

Invalidate()

IsCompiled()

Return

boolean

IsInvalidated()

Return

boolean

Reload()

This action takes platform into account and returns a default version of OpenGL's number to be placed at the top of a shader. For shaders not using OpenGL, this action does not provide useful information. The version number is calculated by Quorum, not the graphics hardware.

SetCode(text code)

Parameters

SetName(text name)

Parameters

SetType(integer type)

Parameters