Libraries.Game.Graphics.VertexData Documentation

Inherits from: Libraries.Language.Object, Libraries.Game.Disposable

Summary

Actions Summary Table

ActionsDescription
Bind(Libraries.Game.Graphics.Shaders.ShaderProgram program, Libraries.Containers.Array<integer> locations)
Bind(Libraries.Game.Graphics.Shaders.ShaderProgram program)
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Dispose()This action releases the memory stored by this VertexData.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
Get(integer index)This returns a single element from within the VertexData at the given index.
GetAttributes()This action will return the VertexAttributes that describe this VertexData.
GetBuffer()
GetHashCode()This action gets the hash code for an object.
GetMaxSize()This action returns the maximum number of vertices that can be stored in this VertexData object.
GetSize()This action returns the number of vertices currently stored in this VertexData object.
Reload()Used to invalidate the data when applicable, e.
SetVertices(Libraries.Containers.Number32BitArray vertices)
Unbind(Libraries.Game.Graphics.Shaders.ShaderProgram program)
Unbind(Libraries.Game.Graphics.Shaders.ShaderProgram program, Libraries.Containers.Array<integer> locations)
UpdateVertices(integer targetOffset, Libraries.Containers.Number32BitArray vertices, integer sourceOffset, integer count)

Actions Documentation

Bind(Libraries.Game.Graphics.Shaders.ShaderProgram program, Libraries.Containers.Array<integer> locations)

Parameters

Bind(Libraries.Game.Graphics.Shaders.ShaderProgram program)

Parameters

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.

Dispose()

This action releases the memory stored by this VertexData. This should only be used when the VertexData is not in use and will not be needed again!

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.

Get(integer index)

This returns a single element from within the VertexData at the given index.

Parameters

Return

number:

GetAttributes()

This action will return the VertexAttributes that describe this VertexData.

Return

Libraries.Game.Graphics.VertexAttributes:

GetBuffer()

Return

Libraries.Game.Graphics.Number32BitBuffer

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.

GetMaxSize()

This action returns the maximum number of vertices that can be stored in this VertexData object.

Return

integer:

GetSize()

This action returns the number of vertices currently stored in this VertexData object.

Return

integer:

Reload()

Used to invalidate the data when applicable, e.g. due to context loss.

SetVertices(Libraries.Containers.Number32BitArray vertices)

Parameters

Unbind(Libraries.Game.Graphics.Shaders.ShaderProgram program)

Parameters

Unbind(Libraries.Game.Graphics.Shaders.ShaderProgram program, Libraries.Containers.Array<integer> locations)

Parameters

UpdateVertices(integer targetOffset, Libraries.Containers.Number32BitArray vertices, integer sourceOffset, integer count)

Parameters