Libraries.Game.Graphics.TextureData Documentation

This class is used to store information about a data. This class is for internal use by the game engine, and most users will never need to interact with this class directly.

Inherits from: Libraries.Language.Object

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.

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)

ConsumePixelMap()

Returns the PixelMap stored by this TextureData. The TextureData must be set up using Prepare() before calling this action.

Return

Libraries.Game.Graphics.PixelMap:

DisposePixelMap()

Returns whether or not the caller of ConsumePixelMap should also dispose of it.

Return

boolean:

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)

GetFormat()

Returns the Format of the stored PixelMap data.

Return

Libraries.Game.Graphics.Format:

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

GetHeight()

Returns the height of the stored PixelMap data.

Return

integer:

GetWidth()

Returns the width of the stored PixelMap data.

Return

integer:

IsCustomData()

Determines if the TextureData is a default type. If so, this returns true.

Return

boolean:

IsManaged()

Returns whether or not the TextureData can handle a loss of OpenGL context automatically.

Return

boolean:

IsPrepared()

This action returns whether the TextureData has been prepared yet.

Return

boolean:

Prepare()

This action prepares the TextureData for use by OpenGL.

UseMipMaps()

Returns whether or not the TextureData should be additionally used to generate mip maps.

Return

boolean: