Wrapper for the operations that are used to clear the draw buffers. More...

#include </home/chochlik/devel/oglplus/include/oglplus/context/buffer_clearing.hpp>

Inheritance diagram for oglplus::context::BufferClearing:

Static Public Member Functions
static void	ClearColor (GLclampf r, GLclampf g, GLclampf b, GLclampf a)
	Sets the clear color. More...

static void	ClearDepth (GLclampd d)
	Sets the clear depth. More...

static void	ClearStencil (GLint s)
	Sets the clear stencil buffer value. More...

static ClrBits	Clear (void)
	Clears buffers specified by calling functions of the returned object. More...

static void	Clear (Bitfield< oglplus::ClearBit > bits)
	Clears buffers specified by the bits parameter. More...

static void	ClearColorBuffer (GLint draw_buffer, const GLint *value)
	Clears the specified color draw buffer. More...

static void	ClearColorBuffer (ColorBuffer buffer, GLint draw_buffer, const GLint *value)
	Clears the specified color draw buffer. More...

static void	ClearColorBuffer (GLint draw_buffer, const GLuint *value)
	Clears the specified color draw buffer. More...

static void	ClearColorBuffer (ColorBuffer buffer, GLint draw_buffer, const GLuint *value)
	Clears the specified color draw buffer. More...

static void	ClearColorBuffer (GLint draw_buffer, const GLfloat *value)
	Clears the specified color draw buffer. More...

static void	ClearColorBuffer (ColorBuffer buffer, GLint draw_buffer, const GLfloat *value)
	Clears the specified color draw buffer. More...

static void	ClearDepthBuffer (GLfloat value)
	Clears the depth buffer. More...

static void	ClearStencilBuffer (GLint value)
	Clears the stencil buffer. More...

static void	ClearStencilBuffer (GLfloat depth_value, GLint stencil_value)
	Clears the depth and the stencil buffer. More...

static oglplus::context::RGBAValue	ColorClearValue (void)
	Returns the color value used for clearing of the color buffer. More...

static GLfloat	DepthClearValue (void)
	Returns the depth value used for clearing of the depth buffer. More...

static GLint	ClearStencilValue (void)
	Returns the value used for clearing of the stencil buffer. More...

Detailed Description

Wrapper for the operations that are used to clear the draw buffers.

Member Function Documentation

static ClrBits oglplus::context::BufferClearing::Clear ( void )

static

Clears buffers specified by calling functions of the returned object.

This function returns an object that allows to specify which buffers to clear by calling its ColorBuffer, DepthBuffer and StencilBuffer member functions.

example:

Context gl;
gl.Clear().ColorBuffer();
gl.Clear().ColorBuffer().DepthBuffer();
gl.Clear().StencilBuffer().DepthBuffer();
gl.Clear().ColorBuffer().DepthBuffer().StencilBuffer();

Exceptions

Error

See Also: ClearColor; ClearDepth; ClearStencil

Related OpenGL symbols:: glClear

Examples:: standalone/002_amd_perf_monitor.cpp.

Referenced by Clear().

static void oglplus::context::BufferClearing::Clear ( Bitfield< oglplus::ClearBit > bits )

static

Clears buffers specified by the bits parameter.

This function clears the specified buffers.

example:

Context gl;
gl.Clear(ClearBit::ColorBuffer);
gl.Clear(ClearBit::ColorBuffer|ClearBit::DepthBuffer);
gl.Clear({ClearBit::ColorBuffer});
gl.Clear({ClearBit::ColorBuffer, ClearBit::DepthBuffer});
gl.Clear({ClearBit::ColorBuffer, ClearBit::StencilBuffer});

Exceptions

Error

See Also: ClearColor; ClearDepth; ClearStencil

Related OpenGL symbols:: glClear

References Clear().

static void oglplus::context::BufferClearing::ClearColor	(	GLclampf	r,
		GLclampf	g,
		GLclampf	b,
		GLclampf	a
	)

static

Sets the clear color.

Exceptions

Error

Related OpenGL symbols:: glClearColor

static void oglplus::context::BufferClearing::ClearColorBuffer	(	GLint	draw_buffer,
		const GLint *	value
	)

static

Clears the specified color draw buffer.

This function clears the specified color draw buffer of the currently bound framebuffer.

Exceptions

Error

Related OpenGL symbols:: glClearBuffer GL_GL_COLOR

static void oglplus::context::BufferClearing::ClearColorBuffer	(	ColorBuffer	buffer,
		GLint	draw_buffer,
		const GLint *	value
	)

static

Clears the specified color draw buffer.

This function clears the specified color draw buffer of the currently bound framebuffer.

Exceptions

Error

Related OpenGL symbols:: glClearBuffer

static void oglplus::context::BufferClearing::ClearColorBuffer	(	GLint	draw_buffer,
		const GLuint *	value
	)

static

Clears the specified color draw buffer.

This function clears the specified color draw buffer of the currently bound framebuffer.

Exceptions

Error

Related OpenGL symbols:: glClearBuffer GL_GL_COLOR

static void oglplus::context::BufferClearing::ClearColorBuffer	(	ColorBuffer	buffer,
		GLint	draw_buffer,
		const GLuint *	value
	)

static

Clears the specified color draw buffer.

This function clears the specified color draw buffer of the currently bound framebuffer.

Exceptions

Error

Related OpenGL symbols:: glClearBuffer

static void oglplus::context::BufferClearing::ClearColorBuffer	(	GLint	draw_buffer,
		const GLfloat *	value
	)

static

Clears the specified color draw buffer.

This function clears the specified color draw buffer of the currently bound framebuffer.

Exceptions

Error

Related OpenGL symbols:: glClearBuffer GL_GL_COLOR

static void oglplus::context::BufferClearing::ClearColorBuffer	(	ColorBuffer	buffer,
		GLint	draw_buffer,
		const GLfloat *	value
	)

static

Clears the specified color draw buffer.

This function clears the specified color draw buffer of the currently bound framebuffer.

Exceptions

Error

Related OpenGL symbols:: glClearBuffer

static void oglplus::context::BufferClearing::ClearDepth ( GLclampd d )

static

Sets the clear depth.

Exceptions

Error

Related OpenGL symbols:: glClearDepth

static void oglplus::context::BufferClearing::ClearDepthBuffer ( GLfloat value )

static

Clears the depth buffer.

This function clears the depth buffer of the currently bound framebuffer.

Exceptions

Error

Related OpenGL symbols:: glClearBuffer GL_GL_DEPTH

static void oglplus::context::BufferClearing::ClearStencil ( GLint s )

static

Sets the clear stencil buffer value.

Exceptions

Error

Related OpenGL symbols:: glClearStencil

static void oglplus::context::BufferClearing::ClearStencilBuffer ( GLint value )

static

Clears the stencil buffer.

This function clears the stencil buffer of the currently bound framebuffer.

Exceptions

Error

Related OpenGL symbols:: glClearBuffer GL_GL_STENCIL

static void oglplus::context::BufferClearing::ClearStencilBuffer	(	GLfloat	depth_value,
		GLint	stencil_value
	)

static

Clears the depth and the stencil buffer.

This function clears the depth and stencil buffers of the currently bound framebuffer.

Exceptions

Error

Related OpenGL symbols:: glClearBuffer GL_GL_DEPTH_STENCIL

static GLint oglplus::context::BufferClearing::ClearStencilValue ( void )

static

Returns the value used for clearing of the stencil buffer.

Exceptions

Error

Related OpenGL symbols:: glGet GL_STENCIL_CLEAR_VALUE

static oglplus::context::RGBAValue oglplus::context::BufferClearing::ColorClearValue ( void )

static

Returns the color value used for clearing of the color buffer.

Exceptions

Error

Related OpenGL symbols:: glGet GL_COLOR_CLEAR_VALUE

static GLfloat oglplus::context::BufferClearing::DepthClearValue ( void )

static

Returns the depth value used for clearing of the depth buffer.

Exceptions

Error

Related OpenGL symbols:: glGet GL_DEPTH_CLEAR_VALUE

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

/home/chochlik/devel/oglplus/include/oglplus/context/buffer_clearing.hpp

Static Public Member Functions

Detailed Description

Member Function Documentation