VRS::FrameBufferGL Class Reference
OpenGL Frame Buffer Settings and Operations. More...
#include <vrs/opengl/framebuffergl.h>
Inheritance diagram for VRS::FrameBufferGL:
Public Types | |
| enum | Operations { ClearColor = 1 << 0, ClearDepth = 1 << 1, ClearStencil = 1 << 2, ClearAccum = 1 << 3, MaskColor = 1 << 4, MaskDepth = 1 << 5, MaskStencil = 1 << 6, CopyToImage = 1 << 7, CopyFromImage = 1 << 8 } |
| enum | OpMode { WhenPushed = 1, WhenPopped = 2 } |
Public Member Functions | |
| VRS_SERIALIZABLE_CLASS_ENUM (Operations) | |
| FrameBufferGL (int operations=FrameBufferGL::ClearColor|FrameBufferGL::ClearDepth|FrameBufferGL::ClearStencil) | |
| void | enableOperation (int flagToBeAdded) |
| void | disableOperation (int flagToBeRemoved) |
| int | getOperations () const |
| VRS_SERIALIZABLE_CLASS_ENUM (OpMode) | |
| void | setOperationMode (int mode) |
| int | getOperationMode () const |
| void | setClearColor (const Color &clr) |
| Color | getClearColor () const |
| void | setMaskColor (bool red, bool green, bool blue, bool alpha) |
| int | getMaskColor () const |
| void | setClearAccum (const Color &acc) |
| Color | getClearAccum () const |
| void | setClearDepth (GLclampd depth=1.0) |
| GLclampd | getClearDepth () const |
| void | setMaskDepth (bool onOff) |
| bool | getMaskDepth () const |
| void | setClearStencil (int clearValue=0) |
| int | getClearStencil () const |
| void | setMaskStencil (int stencilMask) |
| int | getMaskStencil () const |
| void | setCopyToImage (Image *image) |
| Image * | getCopyToImage () const |
| void | setCopyFromImage (Image *image) |
| Image * | getCopyFromImage () const |
| void | setBuffer (GLCanvas::CanvasProperties buffer=GLCanvas::RGB_BUFFER) |
| GLCanvas::CanvasProperties | getBuffer () const |
| void | setRegion (const Area &area) |
| Area | getRegion () const |
| VRS_TYPEINFO (FrameBufferGL, MonoAttribute) | |
| VRS_SERIALIZABLE (FrameBufferGL) | |
Static Public Member Functions | |
| static FrameBufferGL * | newColorMask (bool red, bool green, bool blue, bool alpha) |
Detailed Description
OpenGL Frame Buffer Settings and Operations.Member Enumeration Documentation
Constructor & Destructor Documentation
| VRS::FrameBufferGL::FrameBufferGL | ( | int | operations = FrameBufferGL::ClearColor|FrameBufferGL::ClearDepth|FrameBufferGL::ClearStencil |
) |
This attribute allows you to specify OpenGL frame buffer operations. Multiple operations are possible for one attribute. One or more operations can be active simultaneously. The copy and clear operations are either performed
- when the attribute is pushed (pre-operation), or
- when the attribute gets popped (post-operation). The masking operations are activated when the attr is pushed, and deactivated when the attr is popped.
Member Function Documentation
| VRS::FrameBufferGL::VRS_SERIALIZABLE_CLASS_ENUM | ( | Operations | ) |
| void VRS::FrameBufferGL::enableOperation | ( | int | flagToBeAdded | ) |
| void VRS::FrameBufferGL::disableOperation | ( | int | flagToBeRemoved | ) |
| int VRS::FrameBufferGL::getOperations | ( | ) | const [inline] |
| VRS::FrameBufferGL::VRS_SERIALIZABLE_CLASS_ENUM | ( | OpMode | ) |
| void VRS::FrameBufferGL::setOperationMode | ( | int | mode | ) |
| int VRS::FrameBufferGL::getOperationMode | ( | ) | const [inline] |
| void VRS::FrameBufferGL::setClearColor | ( | const Color & | clr | ) |
| Color VRS::FrameBufferGL::getClearColor | ( | ) | const [inline] |
| void VRS::FrameBufferGL::setMaskColor | ( | bool | red, | |
| bool | green, | |||
| bool | blue, | |||
| bool | alpha | |||
| ) |
| int VRS::FrameBufferGL::getMaskColor | ( | ) | const |
| void VRS::FrameBufferGL::setClearAccum | ( | const Color & | acc | ) |
| Color VRS::FrameBufferGL::getClearAccum | ( | ) | const [inline] |
| void VRS::FrameBufferGL::setClearDepth | ( | GLclampd | depth = 1.0 |
) |
| GLclampd VRS::FrameBufferGL::getClearDepth | ( | ) | const [inline] |
| void VRS::FrameBufferGL::setMaskDepth | ( | bool | onOff | ) |
| bool VRS::FrameBufferGL::getMaskDepth | ( | ) | const [inline] |
| void VRS::FrameBufferGL::setClearStencil | ( | int | clearValue = 0 |
) |
| int VRS::FrameBufferGL::getClearStencil | ( | ) | const [inline] |
| void VRS::FrameBufferGL::setMaskStencil | ( | int | stencilMask | ) |
| int VRS::FrameBufferGL::getMaskStencil | ( | ) | const [inline] |
| void VRS::FrameBufferGL::setCopyToImage | ( | Image * | image | ) |
| Image * VRS::FrameBufferGL::getCopyToImage | ( | ) | const [inline] |
| void VRS::FrameBufferGL::setCopyFromImage | ( | Image * | image | ) |
| Image * VRS::FrameBufferGL::getCopyFromImage | ( | ) | const [inline] |
| void VRS::FrameBufferGL::setBuffer | ( | GLCanvas::CanvasProperties | buffer = GLCanvas::RGB_BUFFER |
) |
| GLCanvas::CanvasProperties VRS::FrameBufferGL::getBuffer | ( | ) | const [inline] |
See GLCanvas::snapshot() for the description of "buffer".
| void VRS::FrameBufferGL::setRegion | ( | const Area & | area | ) |
| Area VRS::FrameBufferGL::getRegion | ( | ) | const [inline] |
Specifies a rectangular area which is copied to or from an image/texture. If a zero area is defined, the full frame buffer extend is used.
| static FrameBufferGL* VRS::FrameBufferGL::newColorMask | ( | bool | red, | |
| bool | green, | |||
| bool | blue, | |||
| bool | alpha | |||
| ) | [static] |
| VRS::FrameBufferGL::VRS_TYPEINFO | ( | FrameBufferGL | , | |
| MonoAttribute | ||||
| ) |
| VRS::FrameBufferGL::VRS_SERIALIZABLE | ( | FrameBufferGL | ) |
The documentation for this class was generated from the following file: