com.threerings.opengl.renderer.state
Class AlphaState

java.lang.Object
  com.threerings.opengl.renderer.state.RenderState
      com.threerings.opengl.renderer.state.AlphaState

public class AlphaState
extends RenderState

Contains the alpha testing and blending state.

Field Summary

static AlphaState	ADDITIVE An alpha state for additive objects.
static AlphaState	MASKED An alpha state for masked opaque objects.
static AlphaState	OPAQUE An alpha state for completely opaque objects.
static AlphaState	PREMULTIPLIED An alpha state for objects with premultiplied alpha.
static AlphaState	TRANSLUCENT An alpha state for translucent objects.

Fields inherited from class com.threerings.opengl.renderer.state.RenderState

ALPHA_STATE, ARRAY_STATE, COLOR_MASK_STATE, COLOR_STATE, CULL_STATE, DEPTH_STATE, FOG_STATE, LIGHT_STATE, LINE_STATE, MATERIAL_STATE, POINT_STATE, POLYGON_STATE, SHADER_STATE, STATE_COUNT, STENCIL_STATE, TEXTURE_STATE, TRANSFORM_STATE

Constructor Summary

AlphaState(int alphaTestFunc, float alphaTestRef, int srcBlendFactor, int destBlendFactor)
Creates a new alpha state.

Method Summary

void	apply(Renderer renderer) Applies this state.
boolean	equals(Object other)
int	getAlphaTestFunc() Returns the alpha test function.
float	getAlphaTestRef() Returns the alpha test reference value.
int	getDestBlendFactor() Returns the destination blend factor.
static AlphaState	getInstance(AlphaState state) If there is a shared equivalent to the specified state, this method will return the shared state; otherwise, it will simply return the parameter.
static AlphaState	getInstance(int alphaTestFunc, float alphaTestRef, int srcBlendFactor, int destBlendFactor) If there is a shared instance with the supplied parameters, returns a reference to it; otherwise, returns a new state with the parameters.
int	getSrcBlendFactor() Returns the source blend factor.
static AlphaState	getTestInstance(float reference) Returns an alpha state that only passes fragments with alpha values greater than or equal to the supplied value, then blends them with the destination.
int	getType() Returns the type of this state.

Methods inherited from class com.threerings.opengl.renderer.state.RenderState

copy, createDefaultSet, createEmptySet, getDefaults, isDirty, setDirty

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPAQUE

public static final AlphaState OPAQUE

An alpha state for completely opaque objects.

MASKED

public static final AlphaState MASKED

An alpha state for masked opaque objects.

TRANSLUCENT

public static final AlphaState TRANSLUCENT

An alpha state for translucent objects.

ADDITIVE

public static final AlphaState ADDITIVE

An alpha state for additive objects.

PREMULTIPLIED

public static final AlphaState PREMULTIPLIED

An alpha state for objects with premultiplied alpha.

Constructor Detail

AlphaState

public AlphaState(int alphaTestFunc,
                  float alphaTestRef,
                  int srcBlendFactor,
                  int destBlendFactor)

Creates a new alpha state.

Method Detail

getInstance

public static AlphaState getInstance(int alphaTestFunc,
                                     float alphaTestRef,
                                     int srcBlendFactor,
                                     int destBlendFactor)

If there is a shared instance with the supplied parameters, returns a reference to it; otherwise, returns a new state with the parameters.

getInstance

public static AlphaState getInstance(AlphaState state)

If there is a shared equivalent to the specified state, this method will return the shared state; otherwise, it will simply return the parameter.

getTestInstance

public static AlphaState getTestInstance(float reference)

Returns an alpha state that only passes fragments with alpha values greater than or equal to the supplied value, then blends them with the destination. All requests for instances with the same value will return the same object.

getAlphaTestFunc

public int getAlphaTestFunc()

Returns the alpha test function.

getAlphaTestRef

public float getAlphaTestRef()

Returns the alpha test reference value.

getSrcBlendFactor

public int getSrcBlendFactor()

Returns the source blend factor.

getDestBlendFactor

public int getDestBlendFactor()

Returns the destination blend factor.

getType

public int getType()

Description copied from class: RenderState

Returns the type of this state.

Specified by:

getType in class RenderState

apply

public void apply(Renderer renderer)

Description copied from class: RenderState

Applies this state.

Specified by:

apply in class RenderState

equals

public boolean equals(Object other)

Overrides:

equals in class Object