Package com.jme3.renderer

Class RenderContext

java.lang.Object

com.jme3.renderer.RenderContext

public class RenderContext
extends Object

Represents the current state of the graphics library. This class is used internally to reduce state changes. NOTE: This class is specific to OpenGL.

Field Summary

Fields

Modifier and Type	Field	Description
RenderState.TestFunction	alphaFunc	Alpha test function.
final IDList	attribIndexList	IDList for vertex attributes.
RenderState.StencilOperation	backStencilDepthFailOperation	Action taken when the stencil test passes but the depth test fails on a back-facing polygon.
RenderState.StencilOperation	backStencilDepthPassOperation	Action taken when both tests pass on a back-facing polygon.
RenderState.TestFunction	backStencilFunction	Stencil test function for back-facing polygons.
RenderState.StencilOperation	backStencilStencilFailOperation	Action taken when the stencil test fails on a back-facing polygon.
RenderState.BlendEquation	blendEquation	RGB blend equation for BlendMode.Custom.
RenderState.BlendEquationAlpha	blendEquationAlpha	Alpha blend equation for BlendMode.Custom.
RenderState.BlendMode	blendMode	How to blend input pixels with those already in the color buffer.
int	boundArrayVBO	Currently bound array vertex buffer.
final WeakReference<VertexBuffer>[]	boundAttribs	Vertex attribs currently bound and enabled.
final WeakReference<BufferObject>[]	boundBO	Current bound buffer object IDs for each buffer object unit.
int	boundElementArrayVBO	Currently bound element array vertex buffer.
FrameBuffer	boundFB	Currently bound FrameBuffer.
int	boundFBO	ID of the bound FrameBuffer.
int	boundPixelPackPBO	Currently bound pixel pack pixel buffer.
int	boundRB	Currently bound Renderbuffer.
Shader	boundShader	Shader for rendering.
int	boundShaderProgram	ID of the shader for rendering.
final WeakReference<Image>[]	boundTextures	Current bound texture IDs for each texture unit.
int	boundTextureUnit	Currently bound texture unit.
int	boundVertexArray	ID of the bound vertex array.
ColorRGBA	clearColor	Color applied when a color buffer is cleared.
boolean	clipRectEnabled	Enables the clipping rectangle.
boolean	colorWriteEnabled	Enables color writing.
RenderState.FaceCullMode	cullMode	Criteria for culling faces.
RenderState.TestFunction	depthFunc	Depth test function.
boolean	depthTestEnabled	Enables depth testing for color pixels.
boolean	depthWriteEnabled	Enables depth writing.
RenderState.BlendFunc	dfactorAlpha	Alpha destination blend factor for BlendMode.Custom.
RenderState.BlendFunc	dfactorRGB	RGB destination blend factor for BlendMode.Custom.
RenderState.StencilOperation	frontStencilDepthFailOperation	Action taken when the stencil test passes but the depth test fails on a front-facing polygon.
RenderState.StencilOperation	frontStencilDepthPassOperation	Action taken when both tests pass on a front-facing polygon.
RenderState.TestFunction	frontStencilFunction	Stencil test function for front-facing polygons.
RenderState.StencilOperation	frontStencilStencilFailOperation	Action taken when the stencil test fails on a front-facing polygon.
int	initialDrawBuf	ID of the initial draw buffer.
int	initialReadBuf	ID of the initial read buffer.
float	lineWidth	Line width for meshes.
static final int	maxBufferObjectUnits	Number of buffer object units that JME supports.
static final int	maxTextureUnits	Number of texture units that JME supports.
int	numTexturesSet	No longer used.
float	pointSize	No longer used.
boolean	polyOffsetEnabled	Enables z-order offset for polygons.
float	polyOffsetFactor	Maximum Z slope for z-order offset.
float	polyOffsetUnits	Minimum resolvable depth buffer value for z-order offset.
RenderState.BlendFunc	sfactorAlpha	Alpha source blend factor for BlendMode.Custom.
RenderState.BlendFunc	sfactorRGB	RGB source blend factor for BlendMode.Custom.
boolean	stencilTest	Stencil Buffer state.
final IDList	textureIndexList	IDList for texture units.
boolean	wireframe	Enables wireframe rendering of triangle meshes.

Constructor Summary

Constructors

Constructor	Description
RenderContext()	Instantiates a context with appropriate default values.

Method Summary

Modifier and Type	Method	Description
void	reset()	Resets the RenderContext to default GL state.

Methods inherited from class java.lang.Object

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

Field Details

maxTextureUnits

public static final int maxTextureUnits

Number of texture units that JME supports.

See Also:

• Constant Field Values

maxBufferObjectUnits

public static final int maxBufferObjectUnits

Number of buffer object units that JME supports.

See Also:

• Constant Field Values

cullMode

public RenderState.FaceCullMode cullMode

Criteria for culling faces.

See Also:

• RenderState.setFaceCullMode(com.jme3.material.RenderState.FaceCullMode)

depthTestEnabled

public boolean depthTestEnabled

Enables depth testing for color pixels.

See Also:

• RenderState.setDepthTest(boolean)

depthWriteEnabled

public boolean depthWriteEnabled

Enables depth writing.

See Also:

• RenderState.setDepthWrite(boolean)

colorWriteEnabled

public boolean colorWriteEnabled

Enables color writing.

See Also:

• RenderState.setColorWrite(boolean)

clipRectEnabled

public boolean clipRectEnabled

Enables the clipping rectangle.

See Also:

• Renderer.setClipRect(int, int, int, int)

polyOffsetEnabled

public boolean polyOffsetEnabled

Enables z-order offset for polygons.

See Also:

• RenderState.setPolyOffset(float, float)

polyOffsetFactor

public float polyOffsetFactor

Maximum Z slope for z-order offset.

See Also:

• RenderState.setPolyOffset(float, float)

polyOffsetUnits

public float polyOffsetUnits

Minimum resolvable depth buffer value for z-order offset.

See Also:

• RenderState.setPolyOffset(float, float)

pointSize

public float pointSize

No longer used.

lineWidth

public float lineWidth

Line width for meshes.

See Also:

• RenderState.setLineWidth(float)

blendMode

public RenderState.BlendMode blendMode

How to blend input pixels with those already in the color buffer.

See Also:

• RenderState.setBlendMode(com.jme3.material.RenderState.BlendMode)

blendEquation

public RenderState.BlendEquation blendEquation

RGB blend equation for BlendMode.Custom.

See Also:

• RenderState.setBlendEquation(com.jme3.material.RenderState.BlendEquation)

blendEquationAlpha

public RenderState.BlendEquationAlpha blendEquationAlpha

Alpha blend equation for BlendMode.Custom.

See Also:

• RenderState.setBlendEquationAlpha(com.jme3.material.RenderState.BlendEquationAlpha)

sfactorRGB

public RenderState.BlendFunc sfactorRGB

RGB source blend factor for BlendMode.Custom.

See Also:

• RenderState.setCustomBlendFactors(com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc)

dfactorRGB

public RenderState.BlendFunc dfactorRGB

RGB destination blend factor for BlendMode.Custom.

See Also:

• RenderState.setCustomBlendFactors(com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc)

sfactorAlpha

public RenderState.BlendFunc sfactorAlpha

Alpha source blend factor for BlendMode.Custom.

See Also:

• RenderState.setCustomBlendFactors(com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc)

dfactorAlpha

public RenderState.BlendFunc dfactorAlpha

Alpha destination blend factor for BlendMode.Custom.

See Also:

• RenderState.setCustomBlendFactors(com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc, com.jme3.material.RenderState.BlendFunc)

wireframe

public boolean wireframe

Enables wireframe rendering of triangle meshes.

See Also:

• RenderState.setWireframe(boolean)

boundShaderProgram

public int boundShaderProgram

ID of the shader for rendering.

See Also:

• Renderer.setShader(com.jme3.shader.Shader)

boundShader

public Shader boundShader

Shader for rendering.

See Also:

• Renderer.setShader(com.jme3.shader.Shader)

boundFBO

public int boundFBO

ID of the bound FrameBuffer.

See Also:

• Renderer.setFrameBuffer(com.jme3.texture.FrameBuffer)

boundFB

public FrameBuffer boundFB

Currently bound FrameBuffer.

See Also:

• Renderer.setFrameBuffer(com.jme3.texture.FrameBuffer)

boundRB

public int boundRB

Currently bound Renderbuffer.

See Also:

• Renderer.setFrameBuffer(com.jme3.texture.FrameBuffer)

boundElementArrayVBO

public int boundElementArrayVBO

Currently bound element array vertex buffer.

See Also:

• Renderer.renderMesh(com.jme3.scene.Mesh, int, int, com.jme3.scene.VertexBuffer[])

boundVertexArray

public int boundVertexArray

ID of the bound vertex array.

See Also:

• Renderer.renderMesh(com.jme3.scene.Mesh, int, int, com.jme3.scene.VertexBuffer[])

boundArrayVBO

public int boundArrayVBO

Currently bound array vertex buffer.

See Also:

• Renderer.renderMesh(com.jme3.scene.Mesh, int, int, com.jme3.scene.VertexBuffer[])

boundPixelPackPBO

public int boundPixelPackPBO

Currently bound pixel pack pixel buffer.

numTexturesSet

public int numTexturesSet

No longer used.

boundTextures

public final WeakReference<Image>[] boundTextures

Current bound texture IDs for each texture unit.

See Also:

• Renderer.setTexture(int, com.jme3.texture.Texture)

boundBO

public final WeakReference<BufferObject>[] boundBO

Current bound buffer object IDs for each buffer object unit.

See Also:

• Renderer.setUniformBufferObject(int, com.jme3.shader.BufferObject)
• Renderer.setShaderStorageBufferObject(int, com.jme3.shader.BufferObject)

textureIndexList

public final IDList textureIndexList

IDList for texture units.

See Also:

• Renderer.setTexture(int, com.jme3.texture.Texture)

boundTextureUnit

public int boundTextureUnit

Currently bound texture unit.

See Also:

• Renderer.setTexture(int, com.jme3.texture.Texture)

stencilTest

public boolean stencilTest

Stencil Buffer state.

frontStencilStencilFailOperation

public RenderState.StencilOperation frontStencilStencilFailOperation

Action taken when the stencil test fails on a front-facing polygon.

frontStencilDepthFailOperation

public RenderState.StencilOperation frontStencilDepthFailOperation

Action taken when the stencil test passes but the depth test fails on a front-facing polygon.

frontStencilDepthPassOperation

public RenderState.StencilOperation frontStencilDepthPassOperation

Action taken when both tests pass on a front-facing polygon.

backStencilStencilFailOperation

public RenderState.StencilOperation backStencilStencilFailOperation

Action taken when the stencil test fails on a back-facing polygon.

backStencilDepthFailOperation

public RenderState.StencilOperation backStencilDepthFailOperation

Action taken when the stencil test passes but the depth test fails on a back-facing polygon.

backStencilDepthPassOperation

public RenderState.StencilOperation backStencilDepthPassOperation

Action taken when both tests pass on a back-facing polygon.

frontStencilFunction

public RenderState.TestFunction frontStencilFunction

Stencil test function for front-facing polygons.

backStencilFunction

public RenderState.TestFunction backStencilFunction

Stencil test function for back-facing polygons.

boundAttribs

public final WeakReference<VertexBuffer>[] boundAttribs

Vertex attribs currently bound and enabled. If a slot is null, then it is disabled.

attribIndexList

public final IDList attribIndexList

IDList for vertex attributes.

depthFunc

public RenderState.TestFunction depthFunc

Depth test function.

alphaFunc

public RenderState.TestFunction alphaFunc

Alpha test function.

initialDrawBuf

public int initialDrawBuf

ID of the initial draw buffer.

initialReadBuf

public int initialReadBuf

ID of the initial read buffer.

clearColor

public ColorRGBA clearColor

Color applied when a color buffer is cleared.

Constructor Details

RenderContext

public RenderContext()

Instantiates a context with appropriate default values.

Method Details

reset

public void reset()

Resets the RenderContext to default GL state.