Libraries.Game.Graphics.IndexArray Documentation

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

Summary

Actions Summary Table

ActionsDescription
Bind()Binds this set of indices for use by certain OpenGL functions.
Clear()Clears the underlying buffer used to store the values of this IndexArray.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Dispose()This action is used to release the memory used by this object.
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.
GetMaxSize()This action will return the maximum number of indices this IndexArray can contain.
GetSize()This action will return the current number of indices in this IndexArray.
Load(integer maximumSize)This action will initialize the IndexArray to allow for the given number of indices.
Put(Libraries.Containers.Array<integer> values)This action is used to release the memory used by this object.
Reload()Used to force OpenGL to create a new buffer handle.
SetIndices(Libraries.Containers.Array<integer> indices, integer offset, integer count)This action will set the indices of the IndexArray using the given array, starting at the offset index and iterating through the given number of indices.
SetPosition(integer position)Binds this set of indices for use by certain OpenGL functions.
Unbind()Unbinds this set of indices so it can't be used by certain OpenGL functions.

Actions Documentation

Bind()

Binds this set of indices for use by certain OpenGL functions. For an IndexArray, this does nothing.

Clear()

Clears the underlying buffer used to store the values of this IndexArray.

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 is used to release the memory used by this object.

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.

GetMaxSize()

This action will return the maximum number of indices this IndexArray can contain.

Return

integer:

GetSize()

This action will return the current number of indices in this IndexArray.

Return

integer:

Load(integer maximumSize)

This action will initialize the IndexArray to allow for the given number of indices.

Parameters

Put(Libraries.Containers.Array<integer> values)

This action is used to release the memory used by this object.

Parameters

Reload()

Used to force OpenGL to create a new buffer handle. Used for context loss.

SetIndices(Libraries.Containers.Array<integer> indices, integer offset, integer count)

This action will set the indices of the IndexArray using the given array, starting at the offset index and iterating through the given number of indices.

Parameters

SetPosition(integer position)

Binds this set of indices for use by certain OpenGL functions. For an IndexArray, this does nothing.

Parameters

Unbind()

Unbinds this set of indices so it can't be used by certain OpenGL functions. For an IndexArray, this does nothing.