Libraries.Game.Graphics.VertexArray Documentation

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

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
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.
FillVertexBuffer(Libraries.Containers.Array<number> vertices)This action directly copies an array of vertices into the buffer of this VertexArray.
GetAttributes()This action will return the VertexAttributes that describe this VertexData.
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.
Load(integer numVertices, Libraries.Game.Graphics.VertexAttributes attributes)This action will initialize the VertexArray to use the given number of vertices and to use the provided VertexAttributes.
Reload()Used to invalidate the data when applicable, e.
SetVertices(Libraries.Containers.Array<number> vertices, integer offset, integer count)This action sets the vertices of this VertexData to match the given array of numbers.
UpdateVertices(integer targetOffset, Libraries.Containers.Array<number> vertices, integer sourceOffset, integer count)This action returns the maximum number of vertices that can be stored in this VertexData object.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: 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.

FillVertexBuffer(Libraries.Containers.Array<number> vertices)

This action directly copies an array of vertices into the buffer of this VertexArray.

Parameters

GetAttributes()

This action will return the VertexAttributes that describe this VertexData.

Return

Libraries.Game.Graphics.VertexAttributes:

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:

Load(integer numVertices, Libraries.Game.Graphics.VertexAttributes attributes)

This action will initialize the VertexArray to use the given number of vertices and to use the provided VertexAttributes.

Parameters

Reload()

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

SetVertices(Libraries.Containers.Array<number> vertices, integer offset, integer count)

This action sets the vertices of this VertexData to match the given array of numbers. This will also set an offset of the given amount in to the array, and the user should provide the number of vertices to use from the array by supplying the count.

Parameters

UpdateVertices(integer targetOffset, Libraries.Containers.Array<number> vertices, integer sourceOffset, integer count)

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

Parameters