JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.graph.curve.opengl.RenderState Class Reference

The RenderState is owned by RegionRenderer. More...

Collaboration diagram for com.jogamp.graph.curve.opengl.RenderState:

Classes

class  ProgramLocal
 Representation of RenderState data per ShaderProgram as GLUniformData. More...
 

Public Member Functions

final int id ()
 
final ShaderProgram getShaderProgram ()
 Return the current ShaderProgram. More...
 
final boolean isShaderProgramInUse ()
 Return whether the current ShaderProgram is in use. More...
 
final boolean setShaderProgram (final GL2ES2 gl, final ShaderProgram spNext)
 Sets the current ShaderProgram and enables it. More...
 
final PMVMatrix4f getMatrix ()
 Borrow the current PMVMatrix4f. More...
 
final float getWeight ()
 
final void setWeight (final float v)
 
final Vec4f getColorStatic (final Vec4f rgbaColor)
 
final void setColorStatic (final Vec4f rgbaColor)
 
final void setColorStatic (final float r, final float g, final float b, final float a)
 
final int setAAQuality (final int v)
 Sets pass2 AA-quality rendering value clipped to the range [Region#MIN_AA_QUALITY..Region#MAX_AA_QUALITY] for Graph Region AA render-modes: Region#VBAA_RENDERING_BIT. More...
 
final int getAAQuality ()
 Returns pass2 AA-quality rendering value for Graph Region AA render-modes: Region#VBAA_RENDERING_BIT. More...
 
final int setSampleCount (final int v)
 Sets pass2 AA sample count clipped to the range [Region#MIN_AA_SAMPLE_COUNT..Region#MAX_AA_SAMPLE_COUNT] for Graph Region AA render-modes: VBAA_RENDERING_BIT or Region#MSAA_RENDERING_BIT. More...
 
final int getSampleCount ()
 Returns pass2 AA sample count for Graph Region AA render-modes: VBAA_RENDERING_BIT or Region#MSAA_RENDERING_BIT. More...
 
final void setClipFrustum (final Frustum clipFrustum)
 Set the optional clipping Frustum, which shall be pre-multiplied with the Mv-matrix or null to disable. More...
 
final Frustum getClipFrustum ()
 Returns the optional Mv-premultiplied clipping Frustum or null if unused. More...
 
final int getHintBits ()
 
final boolean hintBitsSet (final int mask)
 
final void setHintBits (final int mask)
 
final void clearHintBits (final int mask)
 
final int getDebugBits ()
 
final boolean debugBitsSet (final int mask)
 
final void setDebugBits (final int mask)
 
final void clearDebugBits (final int mask)
 
final boolean updateUniformLoc (final GL2ES2 gl, final boolean updateLocation, final GLUniformData data, final boolean throwOnError)
 
final boolean updateUniformDataLoc (final GL2ES2 gl, boolean updateLocation, boolean updateData, final GLUniformData data, final boolean throwOnError)
 
final boolean updateAttributeLoc (final GL2ES2 gl, final boolean updateLocation, final GLArrayDataWrapper data, final boolean throwOnError)
 
final RenderState attachTo (final GL2ES2 gl)
 
final boolean detachFrom (final GL2ES2 gl)
 
String toString ()
 

Static Public Member Functions

static final RenderState getRenderState (final GL2ES2 gl)
 
static boolean isWeightValid (final float v)
 

Static Public Attributes

static final int BITHINT_BLENDING_ENABLED = 1 << 0
 Bitfield hint, if set stating enabled GL#GL_BLEND, otherwise disabled. More...
 
static final int BITHINT_GLOBAL_DEPTH_TEST_ENABLED = 1 << 1
 Bitfield hint, if set stating globally enabled GL#GL_DEPTH_TEST, otherwise disabled. More...
 
static final int DEBUG_LINESTRIP = 1 << 0
 

Detailed Description

The RenderState is owned by RegionRenderer.

It holds rendering state data like PMVMatrix4f, viewport, but also the current static color.

Definition at line 53 of file RenderState.java.

Member Function Documentation

◆ attachTo()

final RenderState com.jogamp.graph.curve.opengl.RenderState.attachTo ( final GL2ES2  gl)

Definition at line 398 of file RenderState.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clearDebugBits()

final void com.jogamp.graph.curve.opengl.RenderState.clearDebugBits ( final int  mask)

Definition at line 321 of file RenderState.java.

Here is the caller graph for this function:

◆ clearHintBits()

final void com.jogamp.graph.curve.opengl.RenderState.clearHintBits ( final int  mask)

Definition at line 310 of file RenderState.java.

Here is the caller graph for this function:

◆ debugBitsSet()

final boolean com.jogamp.graph.curve.opengl.RenderState.debugBitsSet ( final int  mask)

Definition at line 315 of file RenderState.java.

◆ detachFrom()

final boolean com.jogamp.graph.curve.opengl.RenderState.detachFrom ( final GL2ES2  gl)

Definition at line 402 of file RenderState.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getAAQuality()

final int com.jogamp.graph.curve.opengl.RenderState.getAAQuality ( )

Returns pass2 AA-quality rendering value for Graph Region AA render-modes: Region#VBAA_RENDERING_BIT.

Definition at line 284 of file RenderState.java.

Here is the caller graph for this function:

◆ getClipFrustum()

final Frustum com.jogamp.graph.curve.opengl.RenderState.getClipFrustum ( )

Returns the optional Mv-premultiplied clipping Frustum or null if unused.

Definition at line 301 of file RenderState.java.

Here is the caller graph for this function:

◆ getColorStatic()

final Vec4f com.jogamp.graph.curve.opengl.RenderState.getColorStatic ( final Vec4f  rgbaColor)

Definition at line 265 of file RenderState.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getDebugBits()

final int com.jogamp.graph.curve.opengl.RenderState.getDebugBits ( )

Definition at line 314 of file RenderState.java.

◆ getHintBits()

final int com.jogamp.graph.curve.opengl.RenderState.getHintBits ( )

Definition at line 303 of file RenderState.java.

◆ getMatrix()

final PMVMatrix4f com.jogamp.graph.curve.opengl.RenderState.getMatrix ( )

Borrow the current PMVMatrix4f.

Definition at line 252 of file RenderState.java.

Here is the caller graph for this function:

◆ getRenderState()

static final RenderState com.jogamp.graph.curve.opengl.RenderState.getRenderState ( final GL2ES2  gl)
static

Definition at line 93 of file RenderState.java.

Here is the call graph for this function:

◆ getSampleCount()

final int com.jogamp.graph.curve.opengl.RenderState.getSampleCount ( )

Returns pass2 AA sample count for Graph Region AA render-modes: VBAA_RENDERING_BIT or Region#MSAA_RENDERING_BIT.

Definition at line 289 of file RenderState.java.

Here is the caller graph for this function:

◆ getShaderProgram()

final ShaderProgram com.jogamp.graph.curve.opengl.RenderState.getShaderProgram ( )

Return the current ShaderProgram.

Definition at line 223 of file RenderState.java.

Here is the caller graph for this function:

◆ getWeight()

final float com.jogamp.graph.curve.opengl.RenderState.getWeight ( )

Definition at line 257 of file RenderState.java.

Here is the caller graph for this function:

◆ hintBitsSet()

final boolean com.jogamp.graph.curve.opengl.RenderState.hintBitsSet ( final int  mask)

Definition at line 304 of file RenderState.java.

Here is the caller graph for this function:

◆ id()

final int com.jogamp.graph.curve.opengl.RenderState.id ( )

Definition at line 220 of file RenderState.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isShaderProgramInUse()

final boolean com.jogamp.graph.curve.opengl.RenderState.isShaderProgramInUse ( )

Return whether the current ShaderProgram is in use.

Definition at line 226 of file RenderState.java.

Here is the call graph for this function:

◆ isWeightValid()

static boolean com.jogamp.graph.curve.opengl.RenderState.isWeightValid ( final float  v)
static

Definition at line 254 of file RenderState.java.

Here is the caller graph for this function:

◆ setAAQuality()

final int com.jogamp.graph.curve.opengl.RenderState.setAAQuality ( final int  v)

Sets pass2 AA-quality rendering value clipped to the range [Region#MIN_AA_QUALITY..Region#MAX_AA_QUALITY] for Graph Region AA render-modes: Region#VBAA_RENDERING_BIT.

Definition at line 282 of file RenderState.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setClipFrustum()

final void com.jogamp.graph.curve.opengl.RenderState.setClipFrustum ( final Frustum  clipFrustum)

Set the optional clipping Frustum, which shall be pre-multiplied with the Mv-matrix or null to disable.

Definition at line 292 of file RenderState.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setColorStatic() [1/2]

final void com.jogamp.graph.curve.opengl.RenderState.setColorStatic ( final float  r,
final float  g,
final float  b,
final float  a 
)

Definition at line 274 of file RenderState.java.

◆ setColorStatic() [2/2]

final void com.jogamp.graph.curve.opengl.RenderState.setColorStatic ( final Vec4f  rgbaColor)

Definition at line 268 of file RenderState.java.

Here is the caller graph for this function:

◆ setDebugBits()

final void com.jogamp.graph.curve.opengl.RenderState.setDebugBits ( final int  mask)

Definition at line 318 of file RenderState.java.

Here is the caller graph for this function:

◆ setHintBits()

final void com.jogamp.graph.curve.opengl.RenderState.setHintBits ( final int  mask)

Definition at line 307 of file RenderState.java.

Here is the caller graph for this function:

◆ setSampleCount()

final int com.jogamp.graph.curve.opengl.RenderState.setSampleCount ( final int  v)

Sets pass2 AA sample count clipped to the range [Region#MIN_AA_SAMPLE_COUNT..Region#MAX_AA_SAMPLE_COUNT] for Graph Region AA render-modes: VBAA_RENDERING_BIT or Region#MSAA_RENDERING_BIT.

Definition at line 287 of file RenderState.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setShaderProgram()

final boolean com.jogamp.graph.curve.opengl.RenderState.setShaderProgram ( final GL2ES2  gl,
final ShaderProgram  spNext 
)

Sets the current ShaderProgram and enables it.

If the given ShaderProgram is not the current, method returns true, otherwise false.

Parameters
gl
spNextthe next current ShaderProgram to be set and enabled
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.

Definition at line 238 of file RenderState.java.

Here is the call graph for this function:

◆ setWeight()

final void com.jogamp.graph.curve.opengl.RenderState.setWeight ( final float  v)

Definition at line 258 of file RenderState.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toString()

String com.jogamp.graph.curve.opengl.RenderState.toString ( )

Definition at line 412 of file RenderState.java.

◆ updateAttributeLoc()

final boolean com.jogamp.graph.curve.opengl.RenderState.updateAttributeLoc ( final GL2ES2  gl,
final boolean  updateLocation,
final GLArrayDataWrapper  data,
final boolean  throwOnError 
)
Parameters
gl
data
throwOnErrorTODO
Returns
true if no error occured, i.e. all locations found, otherwise false.

Definition at line 378 of file RenderState.java.

Here is the call graph for this function:

◆ updateUniformDataLoc()

final boolean com.jogamp.graph.curve.opengl.RenderState.updateUniformDataLoc ( final GL2ES2  gl,
boolean  updateLocation,
boolean  updateData,
final GLUniformData  data,
final boolean  throwOnError 
)
Parameters
gl
updateLocation
updateDataTODO
data
throwOnErrorTODO
Returns
true if no error occured, i.e. all locations found, otherwise false.

Definition at line 355 of file RenderState.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ updateUniformLoc()

final boolean com.jogamp.graph.curve.opengl.RenderState.updateUniformLoc ( final GL2ES2  gl,
final boolean  updateLocation,
final GLUniformData  data,
final boolean  throwOnError 
)
Parameters
gl
updateLocation
data
throwOnErrorTODO
Returns
true if no error occured, i.e. all locations found, otherwise false.

Definition at line 333 of file RenderState.java.

Here is the call graph for this function:

Member Data Documentation

◆ BITHINT_BLENDING_ENABLED

final int com.jogamp.graph.curve.opengl.RenderState.BITHINT_BLENDING_ENABLED = 1 << 0
static

Bitfield hint, if set stating enabled GL#GL_BLEND, otherwise disabled.

Shall be set via setHintBits(int) and cleared via clearHintBits(int).

If set, GLRegion's draw-method will set the proper blend-function and the clear-color to transparent-black in case of multipass FBO rendering.

Shall be set by custom code, e.g. via RegionRenderer's enable and disable RegionRenderer.GLCallback as done in RegionRenderer#defaultBlendEnable and RegionRenderer#defaultBlendDisable.

Definition at line 73 of file RenderState.java.

◆ BITHINT_GLOBAL_DEPTH_TEST_ENABLED

final int com.jogamp.graph.curve.opengl.RenderState.BITHINT_GLOBAL_DEPTH_TEST_ENABLED = 1 << 1
static

Bitfield hint, if set stating globally enabled GL#GL_DEPTH_TEST, otherwise disabled.

Shall be set via setHintBits(int) and cleared via clearHintBits(int).

GLRegion's draw-method may toggle depth test, and reset it's state according to this hint.

Shall be set by custom code, e.g. after RenderState or RegionRenderer construction.

Definition at line 89 of file RenderState.java.

◆ DEBUG_LINESTRIP

final int com.jogamp.graph.curve.opengl.RenderState.DEBUG_LINESTRIP = 1 << 0
static

Definition at line 91 of file RenderState.java.


The documentation for this class was generated from the following file: