SoFrameBufferObject Class

Note: This API is now obsolete.

Create an OpenGL FrameBuffer.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoGLRenderToBuffer
      OIV.InventorSoFrameBufferObject

Namespace: OIV.Inventor
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)

Syntax

C++

Copy

[ObsoleteAttribute("See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class SoFrameBufferObject : SoGLRenderToBuffer

<ObsoleteAttribute("See documentation for more details")>
<EditorBrowsableAttribute(EditorBrowsableState.Never)>
Public Class SoFrameBufferObject
	Inherits SoGLRenderToBuffer

[ObsoleteAttribute(L"See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState::Never)]
public ref class SoFrameBufferObject : public SoGLRenderToBuffer

[<ObsoleteAttribute("See documentation for more details")>]
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
type SoFrameBufferObject =  
    class
        inherit SoGLRenderToBuffer
    end

The SoFrameBufferObject type exposes the following members.

Constructors

	Name	Description
	SoFrameBufferObject	Constructor.

Top

Methods

	Name	Description
	Bind	Calls Bind((OIV.Inventor.Misc.SoState ^)nullptr, true).
	Bind(SoState)	Calls Bind(state, true).
	Bind(SoState, Boolean)	Set this Framebuffer as the current rendering target.
	BindToTexture	Calls BindToTexture(false, -1). (Inherited from SoGLRenderToBuffer.)
	BindToTexture(Boolean)	Calls BindToTexture(bindDepth, -1). (Inherited from SoGLRenderToBuffer.)
	BindToTexture(Boolean, Int32)	Binds the render buffer to a texture object. (Inherited from SoGLRenderToBuffer.)
	Create(SbVec2i32)	Creates a Pbuffer with the specified size. (Inherited from SoGLRenderToBuffer.)
	Create(SbVec2s)	Creates a Pbuffer with the specified size. (Inherited from SoGLRenderToBuffer.)
	Disable	Disable render to buffer Returns true if successful. (Inherited from SoGLRenderToBuffer.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Flush	Calls Flush((OIV.Inventor.Misc.SoState ^)nullptr).
	Flush(SoState)	Blit the multisampling FBO to the regular FBO.
	GetActualSamplesCount	Returns the number of samples actually used by the FBO.
	GetGraphicConfigTemplate	Gets the current graphics configuration template. (Inherited from SoGLRenderToBuffer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMaxSamples	Calls GetMaxSamples((OIV.Inventor.Misc.SoState ^)nullptr).
	GetMaxSamples(SoState)	Returns the maximum number of samples usable for multisampling.
	GetPixelFormat	Returns the current pixel format. (Inherited from SoGLRenderToBuffer.)
	GetSize	Gets current size as an SbVec2s. (Inherited from SoGLRenderToBuffer.)
	GetSize_i32	Gets current size as an SbVec2i32. (Inherited from SoGLRenderToBuffer.)
	GetTexture	Returns the attached texture ID.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsAvailable	Calls IsAvailable((OIV.Inventor.Misc.SoState ^)nullptr).
	IsAvailable(SoState)	Returns true if FrameBuffers are available on this system.
	IsMultisamplingAvailable	Calls IsMultisamplingAvailable((OIV.Inventor.Misc.SoState ^)nullptr).
	IsMultisamplingAvailable(SoState)	Returns true if multisampling is available for FrameBuffers on this system.
	IsPBuffer	Return true if the render buffer is a pbuffer. (Inherited from SoGLRenderToBuffer.)
	MakeCurrent	Enable render to buffer for OpenGL rendering. (Inherited from SoGLRenderToBuffer.)
	ReleaseTexImage	Calls ReleaseTexImage(false). (Inherited from SoGLRenderToBuffer.)
	ReleaseTexImage(Boolean)	Releases the Pbuffer from the current texture object. (Inherited from SoGLRenderToBuffer.)
	Resize(SbVec2i32)	Resizes Pbuffer. (Inherited from SoGLRenderToBuffer.)
	Resize(SbVec2s)	Resizes Pbuffer. (Inherited from SoGLRenderToBuffer.)
	SelectCubeMapFace	Selects the face to be used when the rendering target is a cube map. (Inherited from SoGLRenderToBuffer.)
	SetContextForSharing	++ This has effect only when using PBuffer. (Inherited from SoGLRenderToBuffer.)
	SetGraphicConfigTemplate	Sets a new graphics configuration template. (Inherited from SoGLRenderToBuffer.)
	SetPixelFormat	Sets the current pixel format. (Inherited from SoGLRenderToBuffer.)
	SetRenderToTexture(Boolean)	Calls SetRenderToTexture(enable, OIV.Inventor.SoGLRenderToBuffer.TextureFormats( .SoGLRenderToBuffer.TEXTURE_RGB ), OIV.Inventor.SoGLRenderToBuffer.TextureTargets( .SoGLRenderToBuffer.TEXTURE_2D ), false, false). (Inherited from SoGLRenderToBuffer.)
	SetRenderToTexture(Boolean, SoGLRenderToBufferTextureFormats)	Calls SetRenderToTexture(enable, format, OIV.Inventor.SoGLRenderToBuffer.TextureTargets( .SoGLRenderToBuffer.TEXTURE_2D ), false, false). (Inherited from SoGLRenderToBuffer.)
	SetRenderToTexture(Boolean, SoGLRenderToBufferTextureFormats, SoGLRenderToBufferTextureTargets)	Calls SetRenderToTexture(enable, format, target, false, false). (Inherited from SoGLRenderToBuffer.)
	SetRenderToTexture(Boolean, SoGLRenderToBufferTextureFormats, SoGLRenderToBufferTextureTargets, Boolean)	Calls SetRenderToTexture(enable, format, target, autoMipmap, false). (Inherited from SoGLRenderToBuffer.)
	SetRenderToTexture(Boolean, SoGLRenderToBufferTextureFormats, SoGLRenderToBufferTextureTargets, Boolean, Boolean)	Specifies settings for the Pbuffer creation. (Inherited from SoGLRenderToBuffer.)
	SetSamplesCount	Sets the number of samples for multisampling.
	ShareCurrentContext	++ This has effect only when using PBuffer. (Inherited from SoGLRenderToBuffer.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unbind	Set the previous framebuffer object as the rendering target.

Top

Remarks

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.

Reference

OIV.Inventor Namespace

OIV.InventorSoPBuffer

OIV.Inventor.NodesSoRenderToTarget