Visualization Library v1.0.3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Member Functions | Protected Attributes

vl::Clear Class Reference

The Clear class is a Renderable used to clear the whole or a portion of the color, stencil or depth buffer. More...

#include <Clear.hpp>

Inheritance diagram for vl::Clear:
vl::Renderable vl::Object

List of all members.

Public Member Functions

 Clear ()
virtual void render_Implementation (const Actor *, const Shader *, const Camera *, OpenGLContext *) const
void setClearColorBuffer (bool clear)
void setClearDepthBuffer (bool clear)
void setClearStencilBuffer (bool clear)
void setClearColorValue (const fvec4 &clear_val)
void setClearColorValueInt (const ivec4 &clear_val)
void setClearColorValueUInt (const uvec4 &clear_val)
void setClearDepthValue (float clear_val)
void setClearStencilValue (int clear_val)
void setClearColorMode (EClearColorMode mode)
EClearColorMode clearColorMode () const
void setScissorBox (int x, int y, int w, int h)
 Defines which portion of the rendering buffers should be cleared.
void getScissorBox (int &x, int &y, int &w, int &h)
virtual void updateDirtyBufferObject (EBufferObjectUpdateMode)
 Uploads the data stored in the local buffers on the GPU memory.
virtual void deleteBufferObject ()
 Destroys the BufferObject (vertex buffer objects) associated to this a Renderable.

Protected Member Functions

virtual void computeBounds_Implementation ()

Protected Attributes

fvec4 mClearColorValue
ivec4 mClearColorValueInt
uvec4 mClearColorValueUInt
int mScissorBox [4]
EClearColorMode mClearColorMode
float mClearDepthValue
int mClearStencilValue
bool mClearColorBuffer
bool mClearDepthBuffer
bool mClearStencilBuffer

Detailed Description

The Clear class is a Renderable used to clear the whole or a portion of the color, stencil or depth buffer.

The Clear class is a special Renderable that wraps the functionalities of the following OpenGL functions:

Usually the color, depth and stencil buffers are cleared at the beginning of a rendering when the Viewport is initialized. To handle less common cases the Clear class allows you to perform a clear operation also in the middle of a rendering. Just bind it to an an Actor and setup the appropriate clearing options.

Note:

Definition at line 69 of file Clear.hpp.


Constructor & Destructor Documentation

Clear::Clear (  )

Definition at line 40 of file Clear.cpp.

References mScissorBox, and VL_DEBUG_SET_OBJECT_NAME.


Member Function Documentation

void Clear::render_Implementation ( const Actor ,
const Shader ,
const Camera camera,
OpenGLContext  
) const [virtual]
void vl::Clear::setClearColorBuffer ( bool  clear ) [inline]

Definition at line 78 of file Clear.hpp.

void vl::Clear::setClearDepthBuffer ( bool  clear ) [inline]

Definition at line 80 of file Clear.hpp.

void vl::Clear::setClearStencilBuffer ( bool  clear ) [inline]

Definition at line 82 of file Clear.hpp.

void vl::Clear::setClearColorValue ( const fvec4 clear_val ) [inline]

Definition at line 84 of file Clear.hpp.

void vl::Clear::setClearColorValueInt ( const ivec4 clear_val ) [inline]

Definition at line 86 of file Clear.hpp.

void vl::Clear::setClearColorValueUInt ( const uvec4 clear_val ) [inline]

Definition at line 88 of file Clear.hpp.

void vl::Clear::setClearDepthValue ( float  clear_val ) [inline]

Definition at line 90 of file Clear.hpp.

void vl::Clear::setClearStencilValue ( int  clear_val ) [inline]

Definition at line 92 of file Clear.hpp.

void vl::Clear::setClearColorMode ( EClearColorMode  mode ) [inline]

Definition at line 94 of file Clear.hpp.

EClearColorMode vl::Clear::clearColorMode (  ) const [inline]

Definition at line 96 of file Clear.hpp.

Referenced by render_Implementation().

void vl::Clear::setScissorBox ( int  x,
int  y,
int  w,
int  h 
) [inline]

Defines which portion of the rendering buffers should be cleared.

The parameters 'x', 'y', 'z', 'w' specify a rectangular area in viewport coordinates. Such area is also clipped against the viewport borders. If 'w' or 'h' are set to -1 then the whole viewport is cleared.

Definition at line 102 of file Clear.hpp.

void vl::Clear::getScissorBox ( int &  x,
int &  y,
int &  w,
int &  h 
) [inline]

Definition at line 104 of file Clear.hpp.

virtual void vl::Clear::updateDirtyBufferObject ( EBufferObjectUpdateMode   ) [inline, virtual]

Uploads the data stored in the local buffers on the GPU memory.

If 'discard_local_data' is set to true the memory used by the local buffers is released.

Implements vl::Renderable.

Definition at line 108 of file Clear.hpp.

virtual void vl::Clear::deleteBufferObject (  ) [inline, virtual]

Destroys the BufferObject (vertex buffer objects) associated to this a Renderable.

Note:
This function does not touch the local (non GPU) data stored in the buffers associated to the vertex attributes and DrawCall.

Implements vl::Renderable.

Definition at line 110 of file Clear.hpp.

virtual void vl::Clear::computeBounds_Implementation (  ) [inline, protected, virtual]

Implements vl::Renderable.

Definition at line 113 of file Clear.hpp.


Member Data Documentation

Definition at line 116 of file Clear.hpp.

Referenced by render_Implementation().

Definition at line 117 of file Clear.hpp.

Referenced by render_Implementation().

Definition at line 118 of file Clear.hpp.

Referenced by render_Implementation().

int vl::Clear::mScissorBox[4] [protected]

Definition at line 119 of file Clear.hpp.

Referenced by Clear(), and render_Implementation().

Definition at line 120 of file Clear.hpp.

float vl::Clear::mClearDepthValue [protected]

Definition at line 121 of file Clear.hpp.

Referenced by render_Implementation().

Definition at line 122 of file Clear.hpp.

Referenced by render_Implementation().

bool vl::Clear::mClearColorBuffer [protected]

Definition at line 123 of file Clear.hpp.

Referenced by render_Implementation().

bool vl::Clear::mClearDepthBuffer [protected]

Definition at line 124 of file Clear.hpp.

Referenced by render_Implementation().

Definition at line 125 of file Clear.hpp.

Referenced by render_Implementation().


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

Visualization Library v1.0.3 Reference Documentation
Copyright Michele Bosi. All rights reserved.
Updated on Tue Feb 7 2017 00:55:09.
Permission is granted to use this page to write and publish articles regarding Visualization Library.