eq::FrameBufferObject Class Reference
A C++ class to abstract GL frame buffer objects. More...
#include <frameBufferObject.h>
Public Member Functions | |
| FrameBufferObject (GLEWContext *const glewContext) | |
| Constructs a new Frame Buffer Object. | |
| ~FrameBufferObject () | |
| Destruct the Frame Buffer Object. | |
| bool | init (const int width, const int height, const int depthSize, const int stencilSize) |
| Initialize the Frame Buffer Object. | |
| void | setColorFormat (const GLuint format) |
| Set format for all color textures, if desired format differs from default. | |
| void | exit () |
| De-initialize the Frame Buffer Object. | |
| void | bind () |
| Bind to the Frame Buffer Object. | |
| void | unbind () |
| Unbind any Frame Buffer Object. | |
| bool | resize (const int width, const int height) |
| GLEWContext * | glewGetContext () |
| const GLEWContext * | glewGetContext () const |
| const TextureVector & | getColorTextures () const |
| const Texture & | getDepthTexture () const |
| const Texture & | getStencilTexture () const |
| const std::string & | getErrorMessage () |
| PixelViewport | getPixelViewport () const |
| bool | addColorTexture () |
| Add one texture to FBO. | |
Detailed Description
A C++ class to abstract GL frame buffer objects.Definition at line 30 of file frameBufferObject.h.
Member Function Documentation
| void eq::FrameBufferObject::setColorFormat | ( | const GLuint | format | ) |
Set format for all color textures, if desired format differs from default.
This function should be called before init function.
- Parameters:
-
format new format of color texture
Definition at line 72 of file frameBufferObject.cpp.
Referenced by eq::OSWindow::configInitFBO().
| void eq::FrameBufferObject::exit | ( | ) |
De-initialize the Frame Buffer Object.
Definition at line 56 of file frameBufferObject.cpp.
References eq::Texture::flush().
Referenced by eq::OSWindow::configExitFBO(), and ~FrameBufferObject().
| const TextureVector& eq::FrameBufferObject::getColorTextures | ( | ) | const [inline] |
| const Texture& eq::FrameBufferObject::getDepthTexture | ( | ) | const [inline] |
| const Texture& eq::FrameBufferObject::getStencilTexture | ( | ) | const [inline] |
| const std::string& eq::FrameBufferObject::getErrorMessage | ( | ) | [inline] |
- Returns:
- the reason for the last failed operation.
Definition at line 76 of file frameBufferObject.h.
Referenced by eq::OSWindow::configInitFBO().
| PixelViewport eq::FrameBufferObject::getPixelViewport | ( | ) | const |
- Returns:
- the size of this framebuffer object.
Definition at line 200 of file frameBufferObject.cpp.
Referenced by eq::Channel::setupAssemblyState().
| bool eq::FrameBufferObject::addColorTexture | ( | ) |
Add one texture to FBO.
When FBO class is created it has one color texture by default. Maximal number of textures per FBO is 16. Added color texture will have the same format as already added textures.
- Returns:
- false if color texture can't be added, otherwise true
Definition at line 78 of file frameBufferObject.cpp.
References EQERROR.
The documentation for this class was generated from the following files:
