Wrapper for OpenGL framebuffer operations. More...

#include </home/chochlik/devel/oglplus/include/oglplus/framebuffer.hpp>

Inheritance diagram for oglplus::FramebufferOps:

Classes
struct	Property
	Types related to Framebuffer. More...

Public Types
typedef FramebufferTarget	Target
	Framebuffer bind targets.

Public Member Functions
void	Bind (Target target) const
	Bind this framebuffer to the specified target. More...

Static Public Member Functions
static void	BindDefault (Target target)
	Binds the default framebuffer to the specified target. More...

static void	Unbind (Target target)
	Binds the default framebuffer to the specified target. More...

static FramebufferStatus	Status (Target target)
	Checks the status of the framebuffer. More...

static bool	IsComplete (Target target)
	Returns true if the framebuffer is complete. More...

static void	Complete (Target target)
	Throws an exception if the framebuffer is not complete.

static void	AttachRenderbuffer (Target target, Property::Attachment attachment, const RenderbufferOps &renderbuffer)
	Attach a `renderbuffer` to the `attachment` point of `target`. More...

static void	AttachColorRenderbuffer (Target target, FramebufferColorAttachmentNumber attachment_no, const RenderbufferOps &renderbuffer)
	Attach a `renderbuffer` to the color `attachment_no` of `target`. More...

static void	AttachTexture (Target target, Property::Attachment attachment, const TextureOps &texture, GLint level)
	Attach a `texture` to the `attachment` point of `target`. More...

static void	AttachColorTexture (Target target, FramebufferColorAttachmentNumber attachment_no, const TextureOps &texture, GLint level)
	Attach a `texture` to the color `attachment` point of `target`. More...

static void	AttachTexture1D (Target target, Property::Attachment attachment, Texture::Target textarget, const TextureOps &texture, GLint level)
	Attach a 1D `texture` to the `attachment` point of `target`. More...

static void	AttachTexture2D (Target target, Property::Attachment attachment, Texture::Target textarget, const TextureOps &texture, GLint level)
	Attach a 2D `texture` to the `attachment` point of `target`. More...

static void	AttachTexture3D (Target target, Property::Attachment attachment, Texture::Target textarget, const TextureOps &texture, GLint level, GLint layer)
	Attach a 3D `texture` to the `attachment` point of `target`. More...

static void	AttachTextureLayer (Target target, Property::Attachment attachment, const TextureOps &texture, GLint level, GLint layer)
	Attach a `texture` layer to the `attachment` point of `target`. More...

static void	Invalidate (Target target, const EnumArray< Property::Buffer > &buffers)
	Invalidates the specified attachments or buffers of the Framebuffer. More...

template<typename N >
static void	Invalidate (Target target, GLsizei count, const Property::Buffer *buffers)
	Invalidates the specified attachments or buffers of the Framebuffer. More...

static void	Invalidate (Target target, const EnumArray< Property::Buffer > &buffers, GLint x, GLint y, GLsizei width, GLsizei height)
	Invalidates parts of attachments or buffers of the Framebuffer. More...

static void	Invalidate (Target target, GLsizei count, const Property::Buffer *buffers, GLint x, GLint y, GLsizei width, GLsizei height)
	Invalidates parts of attachments or buffers of the Framebuffer. More...

Detailed Description

Wrapper for OpenGL framebuffer operations.

Note: Do not use this class directly, use FrameBuffer instead

See Also: Framebuffer

Related OpenGL symbols:: glGenFramebuffers glDeleteFramebuffers glIsFramebuffer

Member Function Documentation

static void oglplus::FramebufferOps::AttachColorRenderbuffer	(	Target	target,
		FramebufferColorAttachmentNumber	attachment_no,
		const RenderbufferOps &	renderbuffer
	)

static

Attach a renderbuffer to the color attachment_no of target.

See Also: AttachRenderbuffer; AttachTexture; AttachTextureLayer; AttachTexture1D; AttachTexture2D; AttachTexture3D; AttachColorTexture

Related OpenGL symbols:: glFramebufferRenderbuffer

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::AttachColorRenderbuffer().

static void oglplus::FramebufferOps::AttachColorTexture	(	Target	target,
		FramebufferColorAttachmentNumber	attachment_no,
		const TextureOps &	texture,
		GLint	level
	)

static

Attach a texture to the color attachment point of target.

See Also: AttachRenderbuffer; AttachColorRenderbuffer; AttachTexture1D; AttachTexture2D; AttachTexture3D; AttachTexture; AttachTextureLayer

Related OpenGL symbols:: glFramebufferTexture

Examples:: oglplus/027_flow.cpp, and oglplus/030_rain.cpp.

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::AttachColorTexture().

static void oglplus::FramebufferOps::AttachRenderbuffer	(	Target	target,
		Property::Attachment	attachment,
		const RenderbufferOps &	renderbuffer
	)

static

Attach a renderbuffer to the attachment point of target.

See Also: AttachColorRenderbuffer; AttachTexture; AttachTextureLayer; AttachTexture1D; AttachTexture2D; AttachTexture3D; AttachColorTexture

Related OpenGL symbols:: glFramebufferRenderbuffer

Examples:: oglplus/030_light_rays.cpp, and oglplus/031_motion_blur.cpp.

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::AttachRenderbuffer().

static void oglplus::FramebufferOps::AttachTexture	(	Target	target,
		Property::Attachment	attachment,
		const TextureOps &	texture,
		GLint	level
	)

static

Attach a texture to the attachment point of target.

See Also: AttachRenderbuffer; AttachColorRenderbuffer; AttachTextureLayer; AttachTexture1D; AttachTexture2D; AttachTexture3D; AttachColorTexture

Requires OpenGL 3.2.

Related OpenGL symbols:: glFramebufferTexture

Examples:: oglplus/030_light_rays.cpp, oglplus/031_motion_blur.cpp, and oglplus/034_billiard_balls.cpp.

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::AttachTexture().

static void oglplus::FramebufferOps::AttachTexture1D	(	Target	target,
		Property::Attachment	attachment,
		Texture::Target	textarget,
		const TextureOps &	texture,
		GLint	level
	)

static

Attach a 1D texture to the attachment point of target.

See Also: AttachRenderbuffer; AttachColorRenderbuffer; AttachTexture2D; AttachTexture3D; AttachColorTexture; AttachTexture; AttachTextureLayer

Related OpenGL symbols:: glFramebufferTexture1D

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::AttachTexture1D().

static void oglplus::FramebufferOps::AttachTexture2D	(	Target	target,
		Property::Attachment	attachment,
		Texture::Target	textarget,
		const TextureOps &	texture,
		GLint	level
	)

static

Attach a 2D texture to the attachment point of target.

See Also: AttachRenderbuffer; AttachColorRenderbuffer; AttachTexture1D; AttachTexture3D; AttachColorTexture; AttachTexture; AttachTextureLayer

Related OpenGL symbols:: glFramebufferTexture2D

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::AttachTexture2D().

static void oglplus::FramebufferOps::AttachTexture3D	(	Target	target,
		Property::Attachment	attachment,
		Texture::Target	textarget,
		const TextureOps &	texture,
		GLint	level,
		GLint	layer
	)

static

Attach a 3D texture to the attachment point of target.

See Also: AttachRenderbuffer; AttachColorRenderbuffer; AttachTexture1D; AttachTexture2D; AttachColorTexture; AttachTexture; AttachTextureLayer

Related OpenGL symbols:: glFramebufferTexture3D

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::AttachTexture3D().

static void oglplus::FramebufferOps::AttachTextureLayer	(	Target	target,
		Property::Attachment	attachment,
		const TextureOps &	texture,
		GLint	level,
		GLint	layer
	)

static

Attach a texture layer to the attachment point of target.

See Also: AttachRenderbuffer; AttachColorRenderbuffer; AttachTexture1D; AttachTexture2D; AttachTexture3D; AttachColorTexture; AttachTexture

Related OpenGL symbols:: glFramebufferTextureLayer

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::AttachTextureLayer().

void oglplus::FramebufferOps::Bind ( Target target) const

Bind this framebuffer to the specified target.

Exceptions

Error

Related OpenGL symbols:: glBindFramebuffer

static void oglplus::FramebufferOps::BindDefault ( Target target)

static

Binds the default framebuffer to the specified target.

Exceptions

Error

Related OpenGL symbols:: glBindFramebuffer

Examples:: oglplus/029_shadow_mapping.cpp, oglplus/031_fog.cpp, oglplus/031_sketch.cpp, oglplus/033_metal_and_glass.cpp, and oglplus/034_billiard_balls.cpp.

References OGLPLUS_VERIFY.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::BindDefault(), and Unbind().

static void oglplus::FramebufferOps::Invalidate	(	Target	target,
		const EnumArray< Property::Buffer > &	buffers
	)

static

Invalidates the specified attachments or buffers of the Framebuffer.

Requires OpenGL 4.3 or the GL_ARB_invalidate_subdata extension.

Related OpenGL symbols:: glInvalidateFramebuffer

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

Referenced by oglplus::BoundTemplate< Base, BaseParam, FramebufferOps >::Invalidate(), and Invalidate().

template<typename N >

static void oglplus::FramebufferOps::Invalidate	(	Target	target,
		GLsizei	count,
		const Property::Buffer *	buffers
	)

static

Invalidates the specified attachments or buffers of the Framebuffer.

Requires OpenGL 4.3 or the GL_ARB_invalidate_subdata extension.

Related OpenGL symbols:: glInvalidateFramebuffer

References Invalidate().

static void oglplus::FramebufferOps::Invalidate	(	Target	target,
		const EnumArray< Property::Buffer > &	buffers,
		GLint	x,
		GLint	y,
		GLsizei	width,
		GLsizei	height
	)

static

Invalidates parts of attachments or buffers of the Framebuffer.

Requires OpenGL 4.3 or the GL_ARB_invalidate_subdata extension.

Related OpenGL symbols:: glInvalidateSubFramebuffer

References oglplus::EnumValueName(), and OGLPLUS_CHECK.

static void oglplus::FramebufferOps::Invalidate	(	Target	target,
		GLsizei	count,
		const Property::Buffer *	buffers,
		GLint	x,
		GLint	y,
		GLsizei	width,
		GLsizei	height
	)