Classes

class Bind

Public Types

enum Status {
  COMPLETE = GL_FRAMEBUFFER_COMPLETE_EXT, INCOMPLETE_ATTACHMENT = GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT, INCOMPLETE_MISSING_ATTACHMENT = GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT, INCOMPLETE_DIMENSIONS = GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT,
  INCOMPLETE_FORMATS = GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT, INCOMPLETE_DRAW_BUFFER = GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT, INCOMPLETE_READ_BUFFER = GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT, INCOMPLETE_MULTISAMPLE = GL_FRAMEBUFFER_INCOMPLETE_MULTISAMPLE_EXT,
  UNSUPPORTED = GL_FRAMEBUFFER_UNSUPPORTED_EXT, STATUS_ERROR
}

Public Member Functions

bool attach (GLenum attachment, GLTexture2D &image, GLint level=0)
void attach (GLenum attachment, GLint zoffset, GLTexture3D &image, GLint level=0)
bool attach (GLenum attachment, const Renderbuffer &Rb)
bool attachColorBuffer (const Renderbuffer &Rb, int i=0)
Render to render buffer.
bool attachColorBuffer (const MemCore::RefPtr< Renderbuffer > &Rb, int i=0)
Render to render buffer pointer.
void attachColorTexture (GLTexture2D &image, GLint level=0)
Render colors to 2D texture.
bool attachDepthBuffer (const Renderbuffer &Rb)
bool attachDepthBuffer (const MemCore::RefPtr< Renderbuffer > &Rb)
void attachDepthTexture (GLTexture2D &image)
Render depth into 2D texture.
bool attachStencilBuffer (const Renderbuffer &Rb)
void bind () const
Select this framebuffer for reading and drawing.
void bind_for_drawing () const
Select this framebuffer for subsequent draw operations.
void bind_for_reading () const
Select this framebuffer for read operations from attached Renderbuffers().
bool Blit (const MemCore::RefPtr< Framebuffer > &Source, GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1, GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1, GLbitfield mask, GLenum filter) const
Copy framebuffer content from a source framebuffer to another one.
bool Blit (const MemCore::RefPtr< Framebuffer > &Source, GLbitfield mask, GLenum filter) const
void detach (GLenum attachment, const GLTexture2D &image)
void detachColorTexture (const GLTexture2D &image, int whichone=0)
Framebuffer ()
Call GenFramebuffer(1).
const Renderbuffer::Properties & getProperties () const
GLuint id () const
Return the OpenGL ID.
MemCore::RefPtr< Renderbuffer > mkRenderBuffer (GLenum internalformat) const
Return a compatible renderbuffer object.
Status status () const
const char * StatusMessage () const
~Framebuffer ()
Destroy the Framebuffer ID (requires valid OpenGL context)

Static Public Member Functions

static bool BlitScreen (const MemCore::RefPtr< Framebuffer > &Source, GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1, GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1, GLbitfield mask, GLenum filter)
Copy framebuffer content to the screen.
static const char * MessageString (Status s)
static void unbind ()
Select the screen for read and draw operations.
static void unbind_for_drawing ()
Select the screen for drawing operations.
static void unbind_for_reading ()
Select the screen for read operations.

Protected Attributes

GLuint ID
Renderbuffer::Properties properties

Detailed Description

Class interface to the OpenGL Framebuffer API.

http://oss.sgi.com/projects/ogl-sample/registry/EXT/framebuffer_object.txt

Application-created framebuffer objects (i.e., those with a non-zero name) differ from the default window-system-provided framebuffer in a few important ways. First and foremost, unlike the window-system-provided framebuffer, application-created-framebuffers have modifiable attachment points for each logical buffer in the framebuffer. Framebuffer-attachable images can be attached to and detached from these attachment points, which are described further in section 4.4.2. Also, the size and format of the images attached to application-created framebuffers are controlled entirely within the GL interface, and are not affected by window-system events, such as pixel format selection, window resizes, and display mode changes.

Additionally, when rendering to or reading from an application created-framebuffer object,

The pixel ownership test always succeeds. In other words, application-created framebuffer objects own all of their pixels.

There are no visible color buffer bitplanes. This means there is no color buffer corresponding to the back, front, left, or right color bitplanes.

The only color buffer bitplanes are the ones defined by the framebuffer attachment points named COLOR_ATTACHMENT0_EXT through COLOR_ATTACHMENTn_EXT.

The only depth buffer bitplanes are the ones defined by the framebuffer attachment point DEPTH_ATTACHMENT_EXT.

The only stencil buffer bitplanes are the ones defined by the framebuffer attachment point STENCIL_ATTACHMENT_EXT.

There is no multisample buffer so the value of the implementation-dependent state variables SAMPLES and SAMPLE_BUFFERS are both 0

There are no accum buffer bitplanes, so the value of the implementation-dependent state variables ACCUM_RED_BITS, ACCUM_GREEN_BITS, ACCUM_BLUE_BITS, and ACCUM_ALPHA_BITS, are all zero.

There are no AUX buffer bitplanes, so the value of the implementation-dependent state variable AUX_BUFFERS is zero.

Constructor & Destructor Documentation

Wizt::Framebuffer::Framebuffer ( )

Call GenFramebuffer(1).

Constructor and all member functions MUST be called with a valid OpenGL context.

Member Function Documentation

bool Wizt::Framebuffer::attachColorBuffer	(	const MemCore::RefPtr< Renderbuffer > &	Rb,
		int	i = `0`
	)		`[inline]`

Render to render buffer pointer.

Deprecated:

void Wizt::Framebuffer::bind_for_reading ( ) const

Select this framebuffer for read operations from attached Renderbuffers().

Note that multisample renderbuffers cannot be read (if they are not bound to the screen) and need to be copied to a non-multisample framebuffer first.

bool Wizt::Framebuffer::Blit	(	const MemCore::RefPtr< Framebuffer > &	Source,
		GLint	srcX0,
		GLint	srcY0,
		GLint	srcX1,
		GLint	srcY1,
		GLint	dstX0,
		GLint	dstY0,
		GLint	dstX1,
		GLint	dstY1,
		GLbitfield	mask,
		GLenum	filter
	)		const

Copy framebuffer content from a source framebuffer to another one.

This operation affects the framebuffer bindings. http://www.opengl.org/registry/specs/EXT/framebuffer_blit.txt

bool Wizt::Framebuffer::BlitScreen	(	const MemCore::RefPtr< Framebuffer > &	Source,
		GLint	srcX0,
		GLint	srcY0,
		GLint	srcX1,
		GLint	srcY1,
		GLint	dstX0,
		GLint	dstY0,
		GLint	dstX1,
		GLint	dstY1,
		GLbitfield	mask,
		GLenum	filter
	)		`[static]`

Copy framebuffer content to the screen.

After this operation, the source will be set as read framebuffer, the draw buffer will be set to the screen.

GLuint Wizt::Framebuffer::id ( ) const [inline]

Return the OpenGL ID.

This is usually not required since this class should provide a complete API.

MemCore::RefPtr<Renderbuffer> Wizt::Framebuffer::mkRenderBuffer ( GLenum internalformat ) const [inline]

Return a compatible renderbuffer object.

This only works if there was at least one Renderbuffer already attached to this Framebuffer.

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

ocean/GLvish/Framebuffer.hpp
ocean/GLvish/Framebuffer.cpp