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

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
ConsumePixelMap()Returns the PixelMap stored by this TextureData.
DisposePixelMap()Returns whether or not the caller of ConsumePixelMap should also dispose of it.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetFormat()Returns the Format of the stored PixelMap data.
GetHashCode()This action gets the hash code for an object.
GetHeight()Returns the height of the stored PixelMap data.
GetWidth()Returns the width of the stored PixelMap data.
IsCustomData()Determines if the TextureData is a default type.
IsManaged()Returns whether or not the TextureData can handle a loss of OpenGL context automatically.
IsPrepared()This action returns whether the TextureData has been prepared yet.
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.

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.

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.

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.

GetFormat()

Returns the Format of the stored PixelMap data.

Return

Libraries.Game.Graphics.Format:

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.

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: