CGII/framework/include/cgv/render/render_buffer.h
2018-05-17 16:01:02 +02:00

45 lines
1.4 KiB
C++

#pragma once
#include <cgv/render/context.h>
#include <cgv/data/component_format.h>
#include "lib_begin.h"
namespace cgv {
namespace render {
/** this class encapsulate render buffers that live on the GPU
which must support frame buffer objects for this to work. */
class CGV_API render_buffer
: public render_component,
public cgv::data::component_format
{
int width, height;
public:
/// construct from description of component format, where the default format specifies a color buffer with alpha channel
render_buffer(const std::string& description = "[R,G,B,A]");
/// destruct the render buffer
void destruct(context& ctx);
/** create a render buffer.
If no extent is specified it is copied from the current viewport. */
void create(context& ctx, int width = -1, int height = -1);
/// check whether the buffer has been created
bool is_created() const;
/// calls the destruct method if necessary
~render_buffer();
/// return the width in pixels of the buffer
int get_width() const;
/// return the height in pixels of the buffer
int get_height() const;
/// return whether the component format corresponds to a depth buffer format
bool is_depth_buffer() const;
/// return whether the component format corresponds to a color buffer format
bool is_color_buffer() const;
// bool is_stencil_buffer() const;
};
}
}
#include <cgv/config/lib_end.h>