Package com.jogamp.graph.curve.opengl

Class RegionRenderer

java.lang.Object

com.jogamp.graph.curve.opengl.RegionRenderer

public final class RegionRenderer
extends Object

OpenGL Region renderer All Region rendering operations utilize a RegionRenderer. The RegionRenderer owns its RenderState, a composition. The RegionRenderer manages and own all used ShaderPrograms, a composition. At its destruction, all ShaderPrograms and its RenderState will be destroyed and released.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegionRenderer.GLCallback	May be passed to RegionRenderer ctor, e.g.

Field Summary

Fields

Modifier and Type	Field	Description
static RegionRenderer.GLCallback	defaultBlendDisable	Default GL.GL_BLEND disable RegionRenderer.GLCallback, simply turning-off the GL.GL_BLEND state and turning-on depth writing via GL.glDepthMask(boolean) if RenderState.BITHINT_GLOBAL_DEPTH_TEST_ENABLED is set.
static RegionRenderer.GLCallback	defaultBlendEnable	Default GL.GL_BLEND enable RegionRenderer.GLCallback, turning-off depth writing via GL.glDepthMask(boolean) if RenderState.BITHINT_GLOBAL_DEPTH_TEST_ENABLED is set and turning-on the GL.GL_BLEND state.

Method Summary

Modifier and Type	Method	Description
void	clearHintMask(int mask)
static RegionRenderer	create()	Create a hardware accelerated RegionRenderer including its RenderState composition.
static RegionRenderer	create(RegionRenderer.GLCallback enableCallback, RegionRenderer.GLCallback disableCallback)	Create a hardware accelerated RegionRenderer including its RenderState composition.
static RegionRenderer	create(PMVMatrix sharedPMVMatrix, RegionRenderer.GLCallback enableCallback, RegionRenderer.GLCallback disableCallback)	Create a hardware accelerated RegionRenderer including its RenderState composition.
void	destroy(GL2ES2 gl)	Deletes all ShaderPrograms and nullifies its references including RenderState#destroy(GL2ES2).
void	enable(GL2ES2 gl, boolean enable)	Enabling or disabling the RenderState's current shader program.
void	enable(GL2ES2 gl, boolean enable, RegionRenderer.GLCallback enableCB, RegionRenderer.GLCallback disableCB)	Same as enable(GL2ES2, boolean) but allowing to force RegionRenderer.GLCallbacks off.
Vec4f	getColorStatic(Vec4f rgbaColor)
int	getHeight()	Return height of current viewport
PMVMatrix	getMatrix()	Borrow the current PMVMatrix.
RenderState	getRenderState()	Return the RenderState composition.
Recti	getViewport()	Borrows the current Rect4i viewport w/o copying.
Recti	getViewport(Recti target)	Copies the current Rect4i viewport in given target and returns it for chaining.
float	getWeight()
int	getWidth()	Return width of current viewport
void	init(GL2ES2 gl)	Initialize shader and bindings for GPU based rendering bound to the given GL object's GLContext if not initialized yet.
boolean	isHintMaskSet(int mask)
boolean	isInitialized()
boolean	isVBOSupported()
void	reshapeNotify(int x, int y, int width, int height)	No PMVMatrix operation is performed here.
void	reshapeOrtho(int width, int height, float near, float far)	Perspective orthogonal, method calls reshapeNotify(int, int, int, int).
void	reshapePerspective(float angle, int width, int height, float near, float far)
void	setColorStatic(float r, float g, float b, float a)
void	setColorStatic(Vec4f rgbaColor)
void	setHintMask(int mask)
void	setWeight(float v)
boolean	useShaderProgram(GL2ES2 gl, int renderModes, boolean pass1, int quality, int sampleCount, TextureSequence colorTexSeq)	Generate, selects and caches the desired Curve-Graph ShaderProgram according to the given parameters.

Methods inherited from class java.lang.Object

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

Field Detail

defaultBlendEnable

public static final RegionRenderer.GLCallback defaultBlendEnable

Default GL.GL_BLEND enable RegionRenderer.GLCallback, turning-off depth writing via GL.glDepthMask(boolean) if RenderState.BITHINT_GLOBAL_DEPTH_TEST_ENABLED is set and turning-on the GL.GL_BLEND state.

Implementation also sets RenderState's blending bit-hint, which will cause GLRegion's draw-method to set the proper blend-function and the clear-color to transparent-black in case of multipass FBO rendering.

See Also:

#create(Vertex.Factory, RenderState, GLCallback, GLCallback), enable(GL2ES2, boolean)

defaultBlendDisable

public static final RegionRenderer.GLCallback defaultBlendDisable

Default GL.GL_BLEND disable RegionRenderer.GLCallback, simply turning-off the GL.GL_BLEND state and turning-on depth writing via GL.glDepthMask(boolean) if RenderState.BITHINT_GLOBAL_DEPTH_TEST_ENABLED is set.

Implementation also clears RenderState's blending bit-hint.

See Also:

#create(Vertex.Factory, RenderState, GLCallback, GLCallback), enable(GL2ES2, boolean)

Method Detail

create

public static RegionRenderer create()

Create a hardware accelerated RegionRenderer including its RenderState composition.

The optional RegionRenderer.GLCallbacks enableCallback and disableCallback maybe used to issue certain tasks at enable(GL2ES2, boolean).
For example, instances defaultBlendEnable and defaultBlendDisable can be utilized to enable and disable GL.GL_BLEND.

Returns:

an instance of Region Renderer

See Also:

enable(GL2ES2, boolean)

create

public static RegionRenderer create(RegionRenderer.GLCallback enableCallback,
                                    RegionRenderer.GLCallback disableCallback)

Create a hardware accelerated RegionRenderer including its RenderState composition.

The optional RegionRenderer.GLCallbacks enableCallback and disableCallback maybe used to issue certain tasks at enable(GL2ES2, boolean).
For example, instances defaultBlendEnable and defaultBlendDisable can be utilized to enable and disable GL.GL_BLEND.

Parameters:

enableCallback - optional RegionRenderer.GLCallback, if not null will be issued at init(gl) and enable(gl, true).

disableCallback - optional RegionRenderer.GLCallback, if not null will be issued at enable(gl, false).

Returns:

an instance of Region Renderer

See Also:

enable(GL2ES2, boolean)

create

public static RegionRenderer create(PMVMatrix sharedPMVMatrix,
                                    RegionRenderer.GLCallback enableCallback,
                                    RegionRenderer.GLCallback disableCallback)

Create a hardware accelerated RegionRenderer including its RenderState composition.

The optional RegionRenderer.GLCallbacks enableCallback and disableCallback maybe used to issue certain tasks at enable(GL2ES2, boolean).
For example, instances defaultBlendEnable and defaultBlendDisable can be utilized to enable and disable GL.GL_BLEND.

Parameters:

sharedPMVMatrix - optional shared PMVMatrix to be used for the RenderState composition.

enableCallback - optional RegionRenderer.GLCallback, if not null will be issued at init(gl) and enable(gl, true).

disableCallback - optional RegionRenderer.GLCallback, if not null will be issued at enable(gl, false).

Returns:

an instance of Region Renderer

See Also:

enable(GL2ES2, boolean)

isInitialized

public final boolean isInitialized()

getViewport

public final Recti getViewport(Recti target)

Copies the current Rect4i viewport in given target and returns it for chaining.

getViewport

public final Recti getViewport()

Borrows the current Rect4i viewport w/o copying.

getWidth

public final int getWidth()

Return width of current viewport

getHeight

public final int getHeight()

Return height of current viewport

isVBOSupported

public final boolean isVBOSupported()

init

public final void init(GL2ES2 gl)
                throws GLException

Initialize shader and bindings for GPU based rendering bound to the given GL object's GLContext if not initialized yet.

Disables the renderer via enable(GL2ES2, boolean) to remove any side-effects, ie ShaderState incl. shader program.

Shall be called once before at initialization before a draw() method, e.g. RegionRenderer#draw(GL2ES2, Region, int)

Parameters:

gl - referencing the current GLContext to which the ShaderState is bound to

Throws:

GLException - if initialization failed

destroy

public final void destroy(GL2ES2 gl)

Deletes all ShaderPrograms and nullifies its references including RenderState#destroy(GL2ES2).

getRenderState

public final RenderState getRenderState()

Return the RenderState composition.

getMatrix

public final PMVMatrix getMatrix()

Borrow the current PMVMatrix.

getWeight

public final float getWeight()

setWeight

public final void setWeight(float v)

getColorStatic

public final Vec4f getColorStatic(Vec4f rgbaColor)

setColorStatic

public final void setColorStatic(Vec4f rgbaColor)

setColorStatic

public final void setColorStatic(float r,
                                 float g,
                                 float b,
                                 float a)

isHintMaskSet

public final boolean isHintMaskSet(int mask)

setHintMask

public final void setHintMask(int mask)

clearHintMask

public final void clearHintMask(int mask)

enable

public final void enable(GL2ES2 gl,
                         boolean enable)

Enabling or disabling the RenderState's current shader program.

useShaderProgram(GL2ES2, int, boolean, int, int, TextureSequence) generates, selects and caches the desired Curve-Graph ShaderProgram and sets it current in the RenderState composition.

In case enable and disable RegionRenderer.GLCallbacks are setup via #create(Vertex.Factory, RenderState, GLCallback, GLCallback), they will be called before toggling the shader program.

Parameters:

gl - current GL object

enable - if true enable the current ShaderProgram, otherwise disable.

See Also:

#create(Vertex.Factory, RenderState, GLCallback, GLCallback), useShaderProgram(GL2ES2, int, boolean, int, int, TextureSequence), RenderState.setShaderProgram(GL2ES2, ShaderProgram), RenderState.getShaderProgram()

enable

public final void enable(GL2ES2 gl,
                         boolean enable,
                         RegionRenderer.GLCallback enableCB,
                         RegionRenderer.GLCallback disableCB)

Same as enable(GL2ES2, boolean) but allowing to force RegionRenderer.GLCallbacks off.

Parameters:

gl - current GL object

enable - if true enable the current ShaderProgram, otherwise disable.

enableCB - explicit RegionRenderer.GLCallback for enable

disableCB - explicit RegionRenderer.GLCallback for disable

See Also:

enable(GL2ES2, boolean)

reshapeNotify

public final void reshapeNotify(int x,
                                int y,
                                int width,
                                int height)

No PMVMatrix operation is performed here.

reshapePerspective

public final void reshapePerspective(float angle,
                                     int width,
                                     int height,
                                     float near,
                                     float far)

reshapeOrtho

public final void reshapeOrtho(int width,
                               int height,
                               float near,
                               float far)

Perspective orthogonal, method calls reshapeNotify(int, int, int, int).

useShaderProgram

public final boolean useShaderProgram(GL2ES2 gl,
                                      int renderModes,
                                      boolean pass1,
                                      int quality,
                                      int sampleCount,
                                      TextureSequence colorTexSeq)

Generate, selects and caches the desired Curve-Graph ShaderProgram according to the given parameters. The newly generated or cached ShaderProgram is set current in the RenderState composition and can be retrieved via RenderState.getShaderProgram().

Parameters:

gl -

renderModes -

pass1 -

quality -

sampleCount -

colorTexSeq -

Returns:

true if a new shader program is being used and hence external uniform-data and -location, as well as the attribute-location must be updated, otherwise false.

See Also:

enable(GL2ES2, boolean), RenderState.setShaderProgram(GL2ES2, ShaderProgram), RenderState.getShaderProgram()