Package com.ardor3d.renderer

Class RenderContext

java.lang.Object

com.ardor3d.renderer.RenderContext

Direct Known Subclasses:

JoglRenderContext

public class RenderContext
extends Object

Represents the state of an individual context in OpenGL.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ContextCapabilities	_capabilities
protected final Object	_contextKey	The object tied to this RenderContext, such as the Canvas, etc.
protected Camera	_currentCamera
protected final EnumMap<RenderState.StateType,RenderState>	_currentStates	RenderStates a Spatial contains during rendering.
protected final Stack<EnumMap<RenderState.StateType,RenderState>>	_enforcedBackStack
protected final EnumMap<RenderState.StateType,RenderState>	_enforcedStates	List of states that override any set states on a spatial if not null.
protected final Object	_glContextRep	Basically this object represents the sharable portion of a GL context...
protected final LineRecord	_lineRecord
protected final RendererRecord	_rendererRecord
protected final EnumMap<RenderState.StateType,StateRecord>	_stateRecords
protected final Stack<AbstractFBOTextureRenderer>	_textureRenderers

Constructor Summary

Constructors

Constructor	Description
RenderContext(Object key, ContextCapabilities caps)
RenderContext(Object key, ContextCapabilities caps, RenderContext shared)

Method Summary

Modifier and Type	Method	Description
void	clearCurrentState(RenderState.StateType type)
void	clearCurrentStates()	sets all current states to null, and therefore forces the use of the default states.
void	clearEnforcedState(RenderState.StateType type)	Clears an enforced render state index by setting it to null.
void	clearEnforcedStates()	sets all enforced states to null.
void	contextLost()	Should only be called on a thread with an active context.
protected RendererRecord	createRendererRecord()
void	enforceState(RenderState state)	Enforce a particular state.
void	enforceStates(EnumMap<RenderState.StateType,RenderState> states)	Enforces the states referenced in the given EnumMap.
ContextCapabilities	getCapabilities()
Object	getContextKey()
Camera	getCurrentCamera()
RenderState	getCurrentState(RenderState.StateType type)
RenderState	getEnforcedState(RenderState.StateType type)
Object	getGlContextRep()
LineRecord	getLineRecord()
RendererRecord	getRendererRecord()
StateRecord	getStateRecord(RenderState.StateType type)
boolean	hasEnforcedStates()
void	invalidateStates()
void	popEnforcedStates()	Restores the enforced states from the stack.
void	popFBOTextureRenderer()
void	pushEnforcedStates()	Saves the currently set states to a stack.
void	pushFBOTextureRenderer(AbstractFBOTextureRenderer top)
void	setCurrentCamera(Camera cam)
void	setCurrentState(RenderState.StateType type, RenderState state)
protected void	setupRecords()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_enforcedStates

protected final EnumMap<RenderState.StateType,RenderState> _enforcedStates

List of states that override any set states on a spatial if not null.

_enforcedBackStack

protected final Stack<EnumMap<RenderState.StateType,RenderState>> _enforcedBackStack

_textureRenderers

protected final Stack<AbstractFBOTextureRenderer> _textureRenderers

_currentStates

protected final EnumMap<RenderState.StateType,RenderState> _currentStates

RenderStates a Spatial contains during rendering.

_stateRecords

protected final EnumMap<RenderState.StateType,StateRecord> _stateRecords

_lineRecord

protected final LineRecord _lineRecord

_rendererRecord

protected final RendererRecord _rendererRecord

_glContextRep

protected final Object _glContextRep

Basically this object represents the sharable portion of a GL context... Textures, displayLists, etc.

_capabilities

protected final ContextCapabilities _capabilities

_contextKey

protected final Object _contextKey

The object tied to this RenderContext, such as the Canvas, etc.

_currentCamera

protected Camera _currentCamera

Constructor Details

RenderContext

public RenderContext(Object key,
 ContextCapabilities caps)

RenderContext

public RenderContext(Object key,
 ContextCapabilities caps,
 RenderContext shared)

Method Details

createRendererRecord

protected RendererRecord createRendererRecord()

setupRecords

protected void setupRecords()

invalidateStates

public void invalidateStates()

getCapabilities

public ContextCapabilities getCapabilities()

getStateRecord

public StateRecord getStateRecord(RenderState.StateType type)

getLineRecord

public LineRecord getLineRecord()

getRendererRecord

public RendererRecord getRendererRecord()

enforceState

public void enforceState(RenderState state)

Enforce a particular state. In other words, the given state will override any state of the same type set on a scene object. Remember to clear the state when done enforcing. Very useful for multipass techniques where multiple sets of states need to be applied to a scenegraph drawn multiple times.

Parameters:

state - state to enforce

enforceStates

public void enforceStates(EnumMap<RenderState.StateType,RenderState> states)

Enforces the states referenced in the given EnumMap.

Parameters:

states - the render states

clearEnforcedState

public void clearEnforcedState(RenderState.StateType type)

Clears an enforced render state index by setting it to null. This allows object specific states to be used.

Parameters:

type - The type of RenderState to clear enforcement on.

clearEnforcedStates

public void clearEnforcedStates()

sets all enforced states to null.

clearCurrentStates

public void clearCurrentStates()

sets all current states to null, and therefore forces the use of the default states.

clearCurrentState

public void clearCurrentState(RenderState.StateType type)

Parameters:

type - the state type to clear.

hasEnforcedStates

public boolean hasEnforcedStates()

getEnforcedState

public RenderState getEnforcedState(RenderState.StateType type)

getCurrentState

public RenderState getCurrentState(RenderState.StateType type)

getContextKey

public Object getContextKey()

setCurrentState

public void setCurrentState(RenderState.StateType type,
 RenderState state)

getCurrentCamera

public Camera getCurrentCamera()

setCurrentCamera

public void setCurrentCamera(Camera cam)

getGlContextRep

public Object getGlContextRep()

pushEnforcedStates

public void pushEnforcedStates()

Saves the currently set states to a stack. Does not changes the currently enforced states.

popEnforcedStates

public void popEnforcedStates()

Restores the enforced states from the stack. Any states enforced or cleared since the last push are reverted.

Throws:

EmptyStackException - if this method is called without first calling pushEnforcedStates()

pushFBOTextureRenderer

public void pushFBOTextureRenderer(AbstractFBOTextureRenderer top)

popFBOTextureRenderer

public void popFBOTextureRenderer()

contextLost

public void contextLost()

Should only be called on a thread with an active context.