VRS::BufferClearance Class Reference
#include <vrs/opengl/fbo/bufferclearancegl.h>
Inheritance diagram for VRS::BufferClearance:
Public Types | |
| enum | ClearPolicy { NoClear = 1, WhenPushed = 2, WhenPopped = 3, WhenTriggered = 4 } |
Public Member Functions | |
| VRS_SERIALIZABLE_CLASS_ENUM (ClearPolicy) | |
| BufferClearance (ClearPolicy policy=WhenPushed, const Color &clearColor=Color(1.0, 1.0, 1.0, 1.0), GLclampd clearDepth=1.0, int clearStencil=0) | |
| ClearPolicy | getClearPolicy () const |
| const Color & | getClearColor () const |
| void | setClearColor (const Color &color) |
| GLclampd | getClearDepth () const |
| int | getClearStencil () const |
| VRS_TYPEINFO (BufferClearance, SharedObj) | |
| VRS_SERIALIZABLE (BufferClearance) | |
Member Enumeration Documentation
< BufferClearance defines the clear policy for framebuffer-attachable images.
Constructor & Destructor Documentation
| VRS::BufferClearance::BufferClearance | ( | ClearPolicy | policy = WhenPushed, |
|
| const Color & | clearColor = Color(1.0,1.0,1.0,1.0), |
|||
| GLclampd | clearDepth = 1.0, |
|||
| int | clearStencil = 0 | |||
| ) | [inline] |
A clear policy defines when to clear a framebuffer-attachable image and the according value for clearing it. When attaching a render target to a framebuffer object its clear policy can be set.
Member Function Documentation
| VRS::BufferClearance::VRS_SERIALIZABLE_CLASS_ENUM | ( | ClearPolicy | ) |
| ClearPolicy VRS::BufferClearance::getClearPolicy | ( | ) | const [inline] |
Clear policy can be either 'NoClear': buffer will not be cleared. 'WhenPushed': buffer wil be cleared before rendering into it. 'WhenPopped': buffer will be cleared after rendering into it. 'WhenTriggered': buffer will be cleared after clearance was triggered manually.
| const Color& VRS::BufferClearance::getClearColor | ( | ) | const [inline] |
Color value for colorbuffer clearance.
| void VRS::BufferClearance::setClearColor | ( | const Color & | color | ) |
Sets a new clear color
| GLclampd VRS::BufferClearance::getClearDepth | ( | ) | const [inline] |
Depth value for depthbuffer clearance.
| int VRS::BufferClearance::getClearStencil | ( | ) | const [inline] |
Stencil value for stencilbuffer clearing.
| VRS::BufferClearance::VRS_TYPEINFO | ( | BufferClearance | , | |
| SharedObj | ||||
| ) |
| VRS::BufferClearance::VRS_SERIALIZABLE | ( | BufferClearance | ) |
The documentation for this class was generated from the following file: