Libraries.Game.Graphics.Filter Documentation

This class is used to set the value of the magnification and minification filters of a particular PixelMap in OpenGL. This is used primarily for internal use. Most users will never need to use this class directly.

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
integer NEAREST_NEIGHBOR
integer BILINEAR

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 gets the currently set value from the Filter.
SetValue(integer type)This action sets the value of the Filter.

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 gets the currently set value from the Filter. The value should be either Filter:NEAREST_NEIGHBOR or Filter:BILINEAR.

Example Code

use Libraries.Game.Graphics.Filter

            Filter filter
            integer value = filter:GetValue()

Return

integer:

SetValue(integer type)

This action sets the value of the Filter. The value should be either Filter:NEAREST_NEIGHBOR or Filter:BILINEAR.

Example Code

use Libraries.Game.Graphics.Filter

            Filter filter
            filter:SetValue(filter:NEAREST_NEIGHBOR)

Parameters