com.openinventor.inventor

Class SoFrameBufferObject

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.SoGLRenderToBuffer

com.openinventor.inventor.SoFrameBufferObject

Deprecated.

As of Open Inventor 9610 See documentation for more details

public class SoFrameBufferObject
extends SoGLRenderToBuffer

Create an OpenGL FrameBuffer. This class encapsulates an OpenGL FrameBuffer object (FBO) which may be used for accelerated off-screen rendering. Unlike a pixmap or offscreen bitmap, a FrameBuffer is allocated in frame buffer memory and can be rendered to directly by the graphics hardware. Unlike Pbuffer, this object is not dependent on the windowing system and shares the current OpenGL context.

FrameBuffers are only available if the graphics hardware supports OpenGL 2.0 or the OpenGL framebufferobject extension. This extension is named "GL_frame_buffer_object".

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later. Use SoRenderToTarget.

See also:

SoPBuffer, SoOffscreenRendererDeprecated since Open Inventor 9610
No longer supported, use SoRenderToTarget instead

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoFrameBufferObject.Attachments Deprecated. Attachement.

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

SoGLRenderToBuffer.CubeMapTextureFaces, SoGLRenderToBuffer.TextureFormats, SoGLRenderToBuffer.TextureTargets

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLOR_ATTACHMENT0 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT0 instead.
static int	COLOR_ATTACHMENT1 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT1 instead.
static int	COLOR_ATTACHMENT10 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT10 instead.
static int	COLOR_ATTACHMENT11 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT11 instead.
static int	COLOR_ATTACHMENT12 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT12 instead.
static int	COLOR_ATTACHMENT13 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT13 instead.
static int	COLOR_ATTACHMENT14 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT14 instead.
static int	COLOR_ATTACHMENT15 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT15 instead.
static int	COLOR_ATTACHMENT2 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT2 instead.
static int	COLOR_ATTACHMENT3 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT3 instead.
static int	COLOR_ATTACHMENT4 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT4 instead.
static int	COLOR_ATTACHMENT5 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT5 instead.
static int	COLOR_ATTACHMENT6 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT6 instead.
static int	COLOR_ATTACHMENT7 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT7 instead.
static int	COLOR_ATTACHMENT8 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT8 instead.
static int	COLOR_ATTACHMENT9 Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT9 instead.
static int	DEPTH_ATTACHMENT Deprecated. Use SoFrameBufferObject.Attachments.DEPTH_ATTACHMENT instead.
static int	DEPTH_STENCIL_ATTACHMENT Deprecated. Use SoFrameBufferObject.Attachments.DEPTH_STENCIL_ATTACHMENT instead.
static int	LAST_ATTACHMENT Deprecated. Use SoFrameBufferObject.Attachments.LAST_ATTACHMENT instead.
static int	STENCIL_ATTACHMENT Deprecated. Use SoFrameBufferObject.Attachments.STENCIL_ATTACHMENT instead.

Fields inherited from class com.openinventor.inventor.SoGLRenderToBuffer

TEXTURE_1D, TEXTURE_2D, TEXTURE_3D, TEXTURE_CUBE_MAP, TEXTURE_CUBE_MAP_NEGATIVE_X, TEXTURE_CUBE_MAP_NEGATIVE_Y, TEXTURE_CUBE_MAP_NEGATIVE_Z, TEXTURE_CUBE_MAP_POSITIVE_X, TEXTURE_CUBE_MAP_POSITIVE_Y, TEXTURE_CUBE_MAP_POSITIVE_Z, TEXTURE_DEPTH, TEXTURE_DEPTH_RGBA, TEXTURE_DEPTH_STENCIL, TEXTURE_DEPTH16, TEXTURE_RECTANGLE, TEXTURE_RGB, TEXTURE_RGB_FLOAT16, TEXTURE_RGB_FLOAT32, TEXTURE_RGBA, TEXTURE_RGBA_FLOAT16, TEXTURE_RGBA_FLOAT32, TEXTURE_STENCIL_INDEX, TEXTURE_STENCIL_INDEX8, TEXTURE_UNKNOW

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoFrameBufferObject() Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	bind() Deprecated. Calls bind((com.openinventor.inventor.misc.SoState)null, (boolean)true).
boolean	bind(SoState state) Deprecated. Calls bind(state, (boolean)true).
boolean	bind(SoState state, boolean bindMultisampleFBO) Deprecated. Set this Framebuffer as the current rendering target.
void	flush() Deprecated. Calls flush((com.openinventor.inventor.misc.SoState)null).
void	flush(SoState state) Deprecated. Blit the multisampling FBO to the regular FBO.
int	getActualSamplesCount() Deprecated. Returns the number of samples actually used by the FBO.
static int	getMaxSamples() Deprecated. Calls getMaxSamples((com.openinventor.inventor.misc.SoState)null).
static int	getMaxSamples(SoState state) Deprecated. Returns the maximum number of samples usable for multisampling.
int	getTexture() Deprecated. Returns the attached texture ID.
static boolean	isAvailable() Deprecated. Calls isAvailable((com.openinventor.inventor.misc.SoState)null).
static boolean	isAvailable(SoState state) Deprecated. Returns true if FrameBuffers are available on this system.
static boolean	isMultisamplingAvailable() Deprecated. Calls isMultisamplingAvailable((com.openinventor.inventor.misc.SoState)null).
static boolean	isMultisamplingAvailable(SoState state) Deprecated. Returns true if multisampling is available for FrameBuffers on this system.
void	setSamplesCount(int samples) Deprecated. Sets the number of samples for multisampling.
void	unbind() Deprecated. Set the previous framebuffer object as the rendering target.

Methods inherited from class com.openinventor.inventor.SoGLRenderToBuffer

bindToTexture, bindToTexture, bindToTexture, create, create, disable, getPixelFormat, getSize, getSizei32, isPBuffer, makeCurrent, releaseTexImage, releaseTexImage, resize, resize, selectCubeMapFace, setContextForSharing, setPixelFormat, setRenderToTexture, setRenderToTexture, setRenderToTexture, setRenderToTexture, setRenderToTexture, shareCurrentContext

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

COLOR_ATTACHMENT0

@Deprecated
public static final int COLOR_ATTACHMENT0

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT0 instead.

COLOR_ATTACHMENT1

@Deprecated
public static final int COLOR_ATTACHMENT1

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT1 instead.

COLOR_ATTACHMENT2

@Deprecated
public static final int COLOR_ATTACHMENT2

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT2 instead.

COLOR_ATTACHMENT3

@Deprecated
public static final int COLOR_ATTACHMENT3

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT3 instead.

COLOR_ATTACHMENT4

@Deprecated
public static final int COLOR_ATTACHMENT4

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT4 instead.

COLOR_ATTACHMENT5

@Deprecated
public static final int COLOR_ATTACHMENT5

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT5 instead.

COLOR_ATTACHMENT6

@Deprecated
public static final int COLOR_ATTACHMENT6

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT6 instead.

COLOR_ATTACHMENT7

@Deprecated
public static final int COLOR_ATTACHMENT7

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT7 instead.

COLOR_ATTACHMENT8

@Deprecated
public static final int COLOR_ATTACHMENT8

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT8 instead.

COLOR_ATTACHMENT9

@Deprecated
public static final int COLOR_ATTACHMENT9

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT9 instead.

COLOR_ATTACHMENT10

@Deprecated
public static final int COLOR_ATTACHMENT10

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT10 instead.

COLOR_ATTACHMENT11

@Deprecated
public static final int COLOR_ATTACHMENT11

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT11 instead.

COLOR_ATTACHMENT12

@Deprecated
public static final int COLOR_ATTACHMENT12

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT12 instead.

COLOR_ATTACHMENT13

@Deprecated
public static final int COLOR_ATTACHMENT13

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT13 instead.

COLOR_ATTACHMENT14

@Deprecated
public static final int COLOR_ATTACHMENT14

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT14 instead.

COLOR_ATTACHMENT15

@Deprecated
public static final int COLOR_ATTACHMENT15

Deprecated. Use SoFrameBufferObject.Attachments.COLOR_ATTACHMENT15 instead.

DEPTH_ATTACHMENT

@Deprecated
public static final int DEPTH_ATTACHMENT

Deprecated. Use SoFrameBufferObject.Attachments.DEPTH_ATTACHMENT instead.

STENCIL_ATTACHMENT

@Deprecated
public static final int STENCIL_ATTACHMENT

Deprecated. Use SoFrameBufferObject.Attachments.STENCIL_ATTACHMENT instead.

DEPTH_STENCIL_ATTACHMENT

@Deprecated
public static final int DEPTH_STENCIL_ATTACHMENT

Deprecated. Use SoFrameBufferObject.Attachments.DEPTH_STENCIL_ATTACHMENT instead.

LAST_ATTACHMENT

@Deprecated
public static final int LAST_ATTACHMENT

Deprecated. Use SoFrameBufferObject.Attachments.LAST_ATTACHMENT instead.

Constructor Detail

SoFrameBufferObject

public SoFrameBufferObject()

Deprecated.

Constructor. Creates an object of this class but does *not* create the FrameBuffer until resize is called.

Method Detail

bind

public boolean bind(SoState state)

Deprecated.

Calls bind(state, (boolean)true).

flush

public void flush()

Deprecated.

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

isAvailable

public static boolean isAvailable()

Deprecated.

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

getMaxSamples

public static int getMaxSamples()

Deprecated.

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

isMultisamplingAvailable

public static boolean isMultisamplingAvailable()

Deprecated.

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

bind

public boolean bind()

Deprecated.

Calls bind((com.openinventor.inventor.misc.SoState)null, (boolean)true).

getMaxSamples

public static int getMaxSamples(SoState state)

Deprecated.

Returns the maximum number of samples usable for multisampling.

unbind

public void unbind()

Deprecated.

Set the previous framebuffer object as the rendering target.

getTexture

public int getTexture()

Deprecated.

Returns the attached texture ID.

bind

public boolean bind(SoState state,
                    boolean bindMultisampleFBO)

Deprecated.

Set this Framebuffer as the current rendering target.

isMultisamplingAvailable

public static boolean isMultisamplingAvailable(SoState state)

Deprecated.

Returns true if multisampling is available for FrameBuffers on this system.
There is no guarantee it is possible to enable multisampling (depends on requested samples).

getActualSamplesCount

public int getActualSamplesCount()

Deprecated.

Returns the number of samples actually used by the FBO. The value is not correct right after a call to setSamplesCount but after the first bind/unbind operation.

isAvailable

public static boolean isAvailable(SoState state)

Deprecated.

Returns true if FrameBuffers are available on this system.
There is no guarantee it is possible to create a framebuffer (depends on requested size, available memory, etc).

setSamplesCount

public void setSamplesCount(int samples)

Deprecated.

Sets the number of samples for multisampling.

flush

public void flush(SoState state)

Deprecated.

Blit the multisampling FBO to the regular FBO. This function must be called before using the result of the frame buffer operation. If there is no MSAA FBO active the function doesn't do anything, so it is safe to call it all the time.