1 #ifndef MSP_GL_FRAMEBUFFER_H_
2 #define MSP_GL_FRAMEBUFFER_H_
7 #include "texturecube.h"
16 enum FramebufferAttachment
18 COLOR_ATTACHMENT0 = GL_COLOR_ATTACHMENT0,
19 COLOR_ATTACHMENT1 = GL_COLOR_ATTACHMENT1,
20 COLOR_ATTACHMENT2 = GL_COLOR_ATTACHMENT2,
21 COLOR_ATTACHMENT3 = GL_COLOR_ATTACHMENT3,
22 DEPTH_ATTACHMENT = GL_DEPTH_ATTACHMENT,
23 STENCIL_ATTACHMENT = GL_STENCIL_ATTACHMENT
26 enum FramebufferStatus
28 FRAMEBUFFER_INCOMPLETE_ATTACHMENT = GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT,
29 FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT = GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT,
30 FRAMEBUFFER_INCOMPLETE_DIMENSIONS = GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT,
31 FRAMEBUFFER_INCOMPLETE_FORMATS = GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT,
32 FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER = GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER,
33 FRAMEBUFFER_INCOMPLETE_READ_BUFFER = GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER,
34 FRAMEBUFFER_UNSUPPORTED = GL_FRAMEBUFFER_UNSUPPORTED,
35 FRAMEBUFFER_COMPLETE = GL_FRAMEBUFFER_COMPLETE
40 COLOR_BUFFER_BIT = GL_COLOR_BUFFER_BIT,
41 DEPTH_BUFFER_BIT = GL_DEPTH_BUFFER_BIT,
42 STENCIL_BUFFER_BIT = GL_STENCIL_BUFFER_BIT,
43 ACCUM_BUFFER_BIT = GL_ACCUM_BUFFER_BIT
49 FRONT_LEFT = GL_FRONT_LEFT,
50 FRONT_RIGHT = GL_FRONT_RIGHT,
51 BACK_LEFT = GL_BACK_LEFT,
52 BACK_RIGHT = GL_BACK_RIGHT,
57 FRONT_AND_BACK = GL_FRONT_AND_BACK
60 class framebuffer_incomplete: public std::runtime_error
63 framebuffer_incomplete(FramebufferStatus);
64 virtual ~framebuffer_incomplete() throw() { }
68 Framebuffer objects can be used to perform offscreen rendering. The most
69 common application is rendering to a texture, which can then be used for
70 fullscreen shader effects.
72 A framebuffer consist of a number of logical buffers, such as color and depth
73 buffers. Renderbuffers and Textures can be attached to the logical buffers. At
74 least one image must be attached for the framebuffer to be usable.
76 Requires the GL_EXT_framebuffer_object extension. The blit functions require
77 the GL_EXT_framebuffer_blit extension.
79 class Framebuffer: public Bindable<Framebuffer>
84 FramebufferAttachment attachment;
94 Attachment(FramebufferAttachment);
95 void set(Renderbuffer &);
96 void set(Texture &, GLenum, unsigned);
101 std::vector<Attachment> attachments;
104 mutable unsigned dirty;
106 Framebuffer(unsigned);
111 unsigned get_width() const { return width; }
112 unsigned get_height() const { return height; }
115 void update_attachment(unsigned) const;
117 unsigned get_attachment_index(FramebufferAttachment);
119 void attach(FramebufferAttachment attch, Renderbuffer &rbuf);
120 void attach(FramebufferAttachment attch, Texture2D &tex, unsigned level = 0);
121 void attach(FramebufferAttachment attch, TextureCube &tex, TextureCubeFace face, unsigned level = 0);
122 void detach(FramebufferAttachment attch);
124 /** Checks the completeness of the framebuffer. Returns
125 FRAMEBUFFER_COMPLETE if the framebuffer is complete and can be rendered to,
126 or one of the error status codes otherwise. */
127 FramebufferStatus check_status() const;
129 /** Ensures that the framebuffer is complete, throwing an exception if it
131 void require_complete() const;
133 void clear(BufferBits);
135 /** Blits a region from another framebuffer into this one. If the source
136 and destination regions have different dimensions, the contents will be
137 stretched. If filter is true, linear interpolation will be used, otherwise
138 no interpolation is done. */
139 void blit_from(const Framebuffer &other, int sx0, int sy0, int sx1, int sy1,
140 int dx0, int dy0, int dx1, int dy1, BufferBits bits, bool filter);
142 /** Blits a region from another framebuffer into this one, retaining its
144 void blit_from(const Framebuffer & other, int sx, int sy,
145 unsigned wd, unsigned ht, int dx, int dy, BufferBits bits);
147 /** Blits the entire contents of another framebuffer into this one. */
148 void blit_from(const Framebuffer &other, BufferBits bits, bool filter);
152 static const Framebuffer *current();
153 static void unbind();
155 static Framebuffer &system();
158 inline BufferBits operator|(BufferBits a, BufferBits b)
159 { return static_cast<BufferBits>(static_cast<int>(a)|static_cast<int>(b)); }