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

Variables Table

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

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)

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)

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

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.

Return

integer:

Example



use Libraries.Game.Graphics.Format

Format format
integer value = format:GetValue()

SetValue(integer type)

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

Parameters

  • integer type

Example



use Libraries.Game.Graphics.Format

Format format
format:SetValue(format:RGBA8888)