Libraries.Game.Graphics.Format Documentation

This class is used to indicate what format should be used in OpenGL for a particular PixelMap. This is used primarily for internal use. Most users will never need to directly interface with this class.

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
integer LUMINANCE_ALPHA
integer RGBA4444
integer ALPHA
integer RGB888
integer RGB565
integer INTENSITY
integer RGBA8888

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
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.
GetValue()This action returns the currently set value of the Format.
SetValue(integer type)This action sets the value of the Format.

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.

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.

GetValue()

This action returns the currently set value of the Format. The value should be equal to the value of one of the seven defined constants in Format.

Example Code

use Libraries.Game.Graphics.Format

            Format format
            integer value = format:GetValue()

Return

integer:

SetValue(integer type)

This action sets the value of the Format. The value should be one of the seven defined constants in Format.

Example Code

use Libraries.Game.Graphics.Format

            Format format
            format:SetValue(format:RGBA8888)

Parameters