com.openinventor.inventor.nodes

Class SoRenderToTarget

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoGroup

com.openinventor.inventor.nodes.SoSeparator

com.openinventor.inventor.nodes.SoRenderToTarget

All Implemented Interfaces:

SafeDisposable

public class SoRenderToTarget
extends SoSeparator

Group node that renders its children to one or more "targets". This group node renders its children to one or more render targets.

Multiple targets can be "attached" to the different outputs of the node.

This node also provides antialiasing. When FrameBufferObjects (FBO) are used (this is the default mode if they are available) multisampling can be configured in order to perform antialiasing on the FBO. This MSAA feature is not related to the viewer's FSAA. The quality factor is set between 0.f(default value) and 1.f. The underlying system will setup the FBO with the correct number of samples according to the quality value and according to the attachments configuration.

By default the node clears the targets when the rendering is started. It is possible to disable this feature by setting the field clearTargets to false.

During rendering, the viewport from the Open Inventor state is used, which means that the current size of the render area is used. It is possible to change this default behavior by setting the size field. Setting it to (-1, -1) will switch back to the default mode, other values will be used as the custom rendering size in pixels. The targets are automatically resized to the correct size.

The SoRenderToTextureProperty node can also be used to create a texture image and is useful for simpler cases.

NOTES:

• Performance:
  • Using the TARGET_COPY mode at each frame really reduces performance because a transfer from GPU memory to CPU memory is performed to transfer the data to the SoSFImage field of the texture.
  • Antialiasing (MSAA) can really reduce performance and increase memory consumption. It can even be impossible to use antialiasing with large FLOAT color attachments.
• Target limitations:
  • At this time only SoTexture2 and SoTexture3 nodes are supported. Using other types in the targets field will result in SoDebugErrors.
• By default the textures are resized using the following rules:
  • RBGA uint8 for the color attachements. (Internal mode is RGBA8)
  • Luminance float32 for the depth attachment. (Internal mode is DEPTH_COMPONENT24).
  • Luminance uint8 for the stencil attachment. It is possible to override the default internal mode for the textures by using the internalFormat field of SoTexture.
• Rendering
  • SoRenderToTarget is an SoSeparator and can be added directly to the scene graph. In this case its children are rendered as part of the main scene graph and inherit properties (camera, light, material, etc) from the main scene graph.
    
    
  • SoRenderToTarget can also be used separate from the main scene graph and re-rendered as-needed by applying an SoGLRenderAction. In this case the children of the SoRenderToTarget will normally include a camera, light, etc node. But also note that, in this case, the OpenGL calls normally made by the viewer and/or SoSceneManager will not be done automatically. For example, the OpenGL depth test is not enabled. Use an SoDepthBuffer node to do this.
• Bounding box
  • WARNING: The 'boundingBoxIgnoring' default value is true.
    Usually the SoRenderToTarget scenegraph is not really part of the main scene and should not have any effect on the bounding box computed for the main scene. For this reason, SORTED_OBJECT_BLEND transparency is not supported for shapes that are children of this node. But in some cases, it can be useful to include the SoRenderToTarget scenegraph's bounding box, like when doing post-processing effects. In that case, manually set 'boundingBoxIgnoring' to false.
• Hardware compatibility:
  • All the exposed features are supported by the FBO rendering subsystem. PBuffer and pixmap might not support some of them. For example it is not possible to have multiple color attachments in PBuffer mode. Those alternative modes are supported only for compatibility with legacy hardware.

Since:

Open Inventor 8.6 File format/default:

RenderToTarget {

modes	AUTO
targets	NULL
layers	0
clearTargets	true
antialiasingQuality	0.F
size	(-1, -1)
enableFragmentsQuery	false

}

Action behavior:

SoGLRenderAction
Performs an offscreen rendering using either FBO, PBuffer or pixmap. Sets: SoCacheElement

See also:

SoTexture, SoTexture2.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoRenderToTarget.Attachments Attachment.
static class	SoRenderToTarget.ModeType This enum defines modifiers for the auto detection mechanism.

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoSeparator

SoSeparator.Cachings, SoSeparator.FastEditings, SoSeparator.RenderUnitIds

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFFloat	antialiasingQuality This field defines the antialiasing quality between 0.0 and 1.0 for the rendering.
static int	AUTO Deprecated. Use SoRenderToTarget.ModeType.AUTO instead.
SoSFBool	clearTargets If this field is set the targets are cleared before the rendering.
static int	COLOR0 Deprecated. Use SoRenderToTarget.Attachments.COLOR0 instead.
static int	COLOR1 Deprecated. Use SoRenderToTarget.Attachments.COLOR1 instead.
static int	COLOR10 Deprecated. Use SoRenderToTarget.Attachments.COLOR10 instead.
static int	COLOR11 Deprecated. Use SoRenderToTarget.Attachments.COLOR11 instead.
static int	COLOR12 Deprecated. Use SoRenderToTarget.Attachments.COLOR12 instead.
static int	COLOR13 Deprecated. Use SoRenderToTarget.Attachments.COLOR13 instead.
static int	COLOR14 Deprecated. Use SoRenderToTarget.Attachments.COLOR14 instead.
static int	COLOR15 Deprecated. Use SoRenderToTarget.Attachments.COLOR15 instead.
static int	COLOR2 Deprecated. Use SoRenderToTarget.Attachments.COLOR2 instead.
static int	COLOR3 Deprecated. Use SoRenderToTarget.Attachments.COLOR3 instead.
static int	COLOR4 Deprecated. Use SoRenderToTarget.Attachments.COLOR4 instead.
static int	COLOR5 Deprecated. Use SoRenderToTarget.Attachments.COLOR5 instead.
static int	COLOR6 Deprecated. Use SoRenderToTarget.Attachments.COLOR6 instead.
static int	COLOR7 Deprecated. Use SoRenderToTarget.Attachments.COLOR7 instead.
static int	COLOR8 Deprecated. Use SoRenderToTarget.Attachments.COLOR8 instead.
static int	COLOR9 Deprecated. Use SoRenderToTarget.Attachments.COLOR9 instead.
static int	DEPTH Deprecated. Use SoRenderToTarget.Attachments.DEPTH instead.
SoSFBool	enableFragmentsQuery This field enables or disables the query counter used to count the number of fragments rasterized during the render to texture operation.
static int	INTERNAL Deprecated. Use SoRenderToTarget.ModeType.INTERNAL instead.
static int	LAST_ENTRY Deprecated. Use SoRenderToTarget.Attachments.LAST_ENTRY instead.
SoMFInt32	layers This field is used when targets are SoTexture3.
SoMFEnum<SoRenderToTarget.ModeType>	modes This defines the mode modifier for the targets.
static int	NONE Deprecated. Use SoRenderToTarget.ModeType.NONE instead.
SoSFVec2i32	size This field allows a custom rendering size for the render to texture.
static int	STENCIL Deprecated. Use SoRenderToTarget.Attachments.STENCIL instead.
static int	TARGET_COPY Deprecated. Use SoRenderToTarget.ModeType.TARGET_COPY instead.
SoMFNode	targets This field allows to attach a texture to a specific attachment.

Fields inherited from class com.openinventor.inventor.nodes.SoSeparator

boundingBoxCaching, CLEAR_ZBUFFER, directVizCaching, DISABLE, fastEditing, KEEP_ZBUFFER, OFF, ON, pickCulling, renderCaching, renderCulling, renderUnitId

Fields inherited from class com.openinventor.inventor.nodes.SoGroup

boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoRenderToTarget() Default constructor.

Method Summary

Modifier and Type	Method and Description
int	getRasterizedSamplesCount() Returns the number of samples generated by the rasterizer during the last GLRender action.
static boolean	isSupported() Calls isSupported((com.openinventor.inventor.misc.SoState)null).
static boolean	isSupported(SoState state) Indicates if this node can be used on the actual hardware.

Methods inherited from class com.openinventor.inventor.nodes.SoSeparator

getNumRenderCaches, setNumRenderCaches

Methods inherited from class com.openinventor.inventor.nodes.SoGroup

addChild, findChild, getChild, getNumChildren, insertChild, removeAllChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

COLOR0

@Deprecated
public static final int COLOR0

Deprecated. Use SoRenderToTarget.Attachments.COLOR0 instead.

COLOR1

@Deprecated
public static final int COLOR1

Deprecated. Use SoRenderToTarget.Attachments.COLOR1 instead.

COLOR2

@Deprecated
public static final int COLOR2

Deprecated. Use SoRenderToTarget.Attachments.COLOR2 instead.

COLOR3

@Deprecated
public static final int COLOR3

Deprecated. Use SoRenderToTarget.Attachments.COLOR3 instead.

COLOR4

@Deprecated
public static final int COLOR4

Deprecated. Use SoRenderToTarget.Attachments.COLOR4 instead.

COLOR5

@Deprecated
public static final int COLOR5

Deprecated. Use SoRenderToTarget.Attachments.COLOR5 instead.

COLOR6

@Deprecated
public static final int COLOR6

Deprecated. Use SoRenderToTarget.Attachments.COLOR6 instead.

COLOR7

@Deprecated
public static final int COLOR7

Deprecated. Use SoRenderToTarget.Attachments.COLOR7 instead.

COLOR8

@Deprecated
public static final int COLOR8

Deprecated. Use SoRenderToTarget.Attachments.COLOR8 instead.

COLOR9

@Deprecated
public static final int COLOR9

Deprecated. Use SoRenderToTarget.Attachments.COLOR9 instead.

COLOR10

@Deprecated
public static final int COLOR10

Deprecated. Use SoRenderToTarget.Attachments.COLOR10 instead.

COLOR11

@Deprecated
public static final int COLOR11

Deprecated. Use SoRenderToTarget.Attachments.COLOR11 instead.

COLOR12

@Deprecated
public static final int COLOR12

Deprecated. Use SoRenderToTarget.Attachments.COLOR12 instead.

COLOR13

@Deprecated
public static final int COLOR13

Deprecated. Use SoRenderToTarget.Attachments.COLOR13 instead.

COLOR14

@Deprecated
public static final int COLOR14

Deprecated. Use SoRenderToTarget.Attachments.COLOR14 instead.

COLOR15

@Deprecated
public static final int COLOR15

Deprecated. Use SoRenderToTarget.Attachments.COLOR15 instead.

DEPTH

@Deprecated
public static final int DEPTH

Deprecated. Use SoRenderToTarget.Attachments.DEPTH instead.

STENCIL

@Deprecated
public static final int STENCIL

Deprecated. Use SoRenderToTarget.Attachments.STENCIL instead.

LAST_ENTRY

@Deprecated
public static final int LAST_ENTRY

Deprecated. Use SoRenderToTarget.Attachments.LAST_ENTRY instead.

AUTO

@Deprecated
public static final int AUTO

Deprecated. Use SoRenderToTarget.ModeType.AUTO instead.

INTERNAL

@Deprecated
public static final int INTERNAL

Deprecated. Use SoRenderToTarget.ModeType.INTERNAL instead.

TARGET_COPY

@Deprecated
public static final int TARGET_COPY

Deprecated. Use SoRenderToTarget.ModeType.TARGET_COPY instead.

NONE

@Deprecated
public static final int NONE

Deprecated. Use SoRenderToTarget.ModeType.NONE instead.

modes

public final SoMFEnum<SoRenderToTarget.ModeType> modes

This defines the mode modifier for the targets. For each target it is possible to specify a mode. Use enum Mode. Default is AUTO.

NOTE: This field is indexed using the Attachment enum. For example (in pseudo-code):

• modes[COLOR0] = TARGET_AND_COPY;
• modes[STENCIL] = INTERNAL;

targets

public final SoMFNode targets

This field allows to attach a texture to a specific attachment. Supported target types are SoTexture2 and SoTexture3, default is empty (no targets).

NOTE: This field is indexed using the Attachment enum. For example (in pseudo-code):

• targets[COLOR0] = rgbaTexture;
• targets[STENCIL] = stencilTexture;

layers

public final SoMFInt32 layers

This field is used when targets are SoTexture3. It describes the layer, along the Z dimension of SoTexture3, where the color attachment must be written. This field is indexed by color attachments (i.e. from COLOR0 to COLOR15) and has no effect when targets are of type SoTexture2 or when target attachments are DEPTH or STENCIL, which require a SoTexture2 Target.

clearTargets

public final SoSFBool clearTargets

If this field is set the targets are cleared before the rendering. Default is true.

antialiasingQuality

public final SoSFFloat antialiasingQuality

This field defines the antialiasing quality between 0.0 and 1.0 for the rendering. The value 1.0 represents the maximun quality possible on this hardware. Default is 0.

NOTE: Hardware limitations: The result depends on the support for multisampling in FBO or the FSAA support for PBuffers.

size

public final SoSFVec2i32 size

This field allows a custom rendering size for the render to texture. When this field is set to the default value (-1, -1) the global viewport size from the viewer is used. The size is in pixels.

enableFragmentsQuery

public final SoSFBool enableFragmentsQuery

This field enables or disables the query counter used to count the number of fragments rasterized during the render to texture operation. Default is false.

The method getRasterizedSamplesCount() can be used to get the result of the query.

Constructor Detail

SoRenderToTarget

public SoRenderToTarget()

Default constructor.

Method Detail

isSupported

public static boolean isSupported()

Calls isSupported((com.openinventor.inventor.misc.SoState)null).

getRasterizedSamplesCount

public int getRasterizedSamplesCount()

Returns the number of samples generated by the rasterizer during the last GLRender action. To enable this feature the enableFragmentsQuery field must be set to true. Otherwise the result is undefined.

isSupported

public static boolean isSupported(SoState state)

Indicates if this node can be used on the actual hardware. When using a debug build of Open Inventor, some "no context available" warning messages may be generated. You can ignore them or see SoGLExtension for an example of using SoGLContext to avoid them.