#ifndef MSP_GL_SEQUENCE_H_
#define MSP_GL_SEQUENCE_H_
-#include <map>
-#include <set>
-#include "blend.h"
+#include <vector>
+#include "color.h"
#include "depthtest.h"
-#include "framebuffer.h"
+#include "frameformat.h"
#include "renderable.h"
-#include "rendertarget.h"
#include "stenciltest.h"
-#include "texture2d.h"
namespace Msp {
namespace GL {
-class Blend;
-class Camera;
-class Clipping;
class Lighting;
class PostProcessor;
-class View;
+class RenderTarget;
/**
-Top-level content class. Typically a Sequence is used as the content
-Renderable for a View or effects such as ShadowMap or EnvironmentMap.
+Top-level content class. Typically a Sequence is used as content for a View
+or sideband content for effects such as ShadowMap or EnvironmentMap.
A Sequence consists of a number of steps. Each step is defined with a
-Renderable and a tag to render it with and may also have Lighting, Clipping,
-DepthTest and Blend states. Scenes can be used to further organize Renderables
-within a step.
+Renderable and a tag to render it with. Lighting, DepthTest and StencilTest
+states may also be applied to steps. Scenes can be used to organize multiple
+Renderables within a step.
+
+The target framebuffer can optionally be cleared before the first step.
PostProcessors can be applied after all of the steps in the Sequence have been
processed. Framebuffer objects are automatically used to pass render results
-to the PostProcessors. High dynamic range and multisample rendering can be
-requested for increased quality.
+to the PostProcessors. The Sequence must be created with a size and a frame
+format.
+
+A Sequence itself is normally rendered with an empty tag. A special "noclear"
+tag can be used to suppress clearing.
*/
-class Sequence: public Renderable
+class Sequence: public Renderable, public NonCopyable
{
public:
class Step
const Lighting *lighting;
DepthTest depth_test;
StencilTest stencil_test;
- Blend blend;
- const Clipping *clipping;
Renderable *renderable;
public:
void set_lighting(const Lighting *);
void set_depth_test(const DepthTest &);
void set_stencil_test(const StencilTest &);
- void set_blend(const Blend &);
- void set_clipping(const Clipping *);
const Lighting *get_lighting() const { return lighting; }
const DepthTest &get_depth_test() const { return depth_test; }
const StencilTest &get_stencil_test() const { return stencil_test; }
- const Blend &get_blend() const { return blend; }
- const Clipping *get_clipping() const { return clipping; }
Renderable *get_renderable() const { return renderable; }
};
private:
- struct PostProcStep
+ struct OwnedObject
{
- PostProcessor *postproc;
- bool owned;
+ void *pointer = 0;
+ void (*delete_func)(void *) = 0;
- PostProcStep(PostProcessor *pp, bool o): postproc(pp), owned(o) { }
+ OwnedObject(void *p, void (*d)(void *)): pointer(p), delete_func(d) { }
};
std::vector<Step> steps;
- std::vector<PostProcStep> postproc;
- unsigned width;
- unsigned height;
- bool hdr;
- bool alpha;
- unsigned samples;
- RenderTarget *target[2];
- RenderTarget *target_ms;
- std::string debug_name;
+ std::vector<PostProcessor *> postproc;
+ unsigned width = 0;
+ unsigned height = 0;
+ FrameFormat target_format;
+ RenderTarget *target[2] = { 0, 0 };
+ RenderTarget *target_ms = 0;
+ bool clear_enabled = false;
+ std::vector<Color> clear_colors;
+ float clear_depth = 1.0f;
+ int clear_stencil = 0;
+ std::vector<OwnedObject> owned_data;
+
+ static const Tag noclear_tag;
public:
- Sequence(unsigned, unsigned, bool = false);
- Sequence(const View &);
- Sequence(const Framebuffer &);
-private:
- void init(unsigned, unsigned);
-public:
+ Sequence() = default;
+ Sequence(unsigned, unsigned, const FrameFormat &);
~Sequence();
- /* Sets high dynamic range mode. Requires floating-point texture support.
- A ColorCurve postprocessor is recommended for full benefit. */
- void set_hdr(bool);
-
- /* Enable or disable alpha channel. When enabled, all render targets are
- created with an RGBA pixel format instead of RGB. */
- void set_alpha(bool);
-
- void set_multisample(unsigned);
-
unsigned get_width() const { return width; }
unsigned get_height() const { return height; }
- bool get_hdr() const { return hdr; }
- unsigned get_multisample() const { return samples; }
+ const FrameFormat &get_target_format() { return target_format; }
+
+ void set_clear_enabled(bool);
+ void set_clear_colors(const std::vector<Color> &);
+ void set_clear_depth(float);
+ void set_clear_stencil(int);
/** Adds a step to the sequence. It's permissible to add the same
- Renderable multiple times. */
+ Renderable or tag multiple times. */
Step &add_step(Tag, Renderable &);
- /** Adds a postprocessor to the sequence. */
+ const std::vector<Step> &get_steps() const { return steps; }
+
+ /** Adds a postprocessor to the sequence. A render target format must be
+ defined. */
void add_postprocessor(PostProcessor &);
- /** Adds a postprocessor to the sequence, transferring ownership. The
- postprocessor will be deleted together with with sequence. It is also
- deleted if this call throws an exception. */
- void add_postprocessor_owned(PostProcessor *);
+ const std::vector<PostProcessor *> &get_postprocessors() const { return postproc; }
-private:
- void add_postprocessor(PostProcessor *, bool);
+ /** Adds an owned object, which will be deleted together with the sequence. */
+ template<typename T>
+ void add_owned(T *p)
+ { owned_data.push_back({ p, [](void *ptr){ delete static_cast<T *>(ptr); } }); }
-public:
virtual void setup_frame(Renderer &);
virtual void finish_frame();
virtual void render(Renderer &, Tag tag = Tag()) const;
-private:
- void create_targets(unsigned);
-
-public:
void set_debug_name(const std::string &);
-private:
- void set_target_debug_names();
};
} // namespace GL
projects / libs / gl.git / blobdiff