source/core/framebuffer.cpp

   1 #include <msp/gl/extensions/arb_draw_buffers.h>
   2 #include <msp/gl/extensions/arb_direct_state_access.h>
   3 #include <msp/gl/extensions/ext_framebuffer_object.h>
   4 #include <msp/gl/extensions/ext_texture_array.h>
   5 #include <msp/gl/extensions/ext_texture3d.h>
   6 #include <msp/gl/extensions/msp_buffer_control.h>
   7 #include <msp/gl/extensions/khr_debug.h>
   8 #include "error.h"
   9 #include "framebuffer.h"
  10 #include "misc.h"
  11 #include "texture2d.h"
  12 #include "texture2dmultisample.h"
  13 #include "texture3d.h"
  14 #include "windowview.h"
  15
  16 using namespace std;
  17
  18 namespace Msp {
  19 namespace GL {
  20
  21 void operator<<(LexicalConverter &conv, FramebufferStatus status)
  22 {
  23         switch(status)
  24         {
  25         case FRAMEBUFFER_INCOMPLETE_ATTACHMENT:
  26                 conv.result("incomplete attachment");
  27                 break;
  28         case FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT:
  29                 conv.result("missing attachment");
  30                 break;
  31         case FRAMEBUFFER_INCOMPLETE_DIMENSIONS:
  32                 conv.result("mismatched attachment dimensions");
  33                 break;
  34         case FRAMEBUFFER_INCOMPLETE_FORMATS:
  35                 conv.result("mismatched attachment formats");
  36                 break;
  37         case FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER:
  38                 conv.result("missing draw buffer attachment");
  39                 break;
  40         case FRAMEBUFFER_INCOMPLETE_READ_BUFFER:
  41                 conv.result("missing read buffer attachment");
  42                 break;
  43         case FRAMEBUFFER_INCOMPLETE_MULTISAMPLE:
  44                 conv.result("mismatched attachment sample counts");
  45                 break;
  46         case FRAMEBUFFER_INCOMPLETE_LAYER_COUNT:
  47                 conv.result("mismatched attachment layer counts");
  48                 break;
  49         case FRAMEBUFFER_INCOMPLETE_LAYER_TARGETS:
  50                 conv.result("mismatched attachment layering");
  51                 break;
  52         case FRAMEBUFFER_UNSUPPORTED:
  53                 conv.result("unsupported");
  54                 break;
  55         default:
  56                 conv.result(lexical_cast<string, unsigned>(status, "%#x"));
  57                 break;
  58         }
  59 }
  60
  61 framebuffer_incomplete::framebuffer_incomplete(FramebufferStatus status):
  62         runtime_error(lexical_cast<string>(status))
  63 { }
  64
  65
  66 Framebuffer::Framebuffer(unsigned i):
  67         id(i),
  68         status(FRAMEBUFFER_COMPLETE),
  69         dirty(0)
  70 {
  71         if(id)
  72                 throw invalid_argument("System framebuffer must have id 0");
  73
  74         int view[4];
  75         glGetIntegerv(GL_VIEWPORT, view);
  76         width = view[2];
  77         height = view[3];
  78 }
  79
  80 Framebuffer::Framebuffer()
  81 {
  82         init();
  83 }
  84
  85 Framebuffer::Framebuffer(FrameAttachment fa)
  86 {
  87         init();
  88         set_format(fa);
  89 }
  90
  91 Framebuffer::Framebuffer(const FrameFormat &f)
  92 {
  93         init();
  94         set_format(f);
  95 }
  96
  97 void Framebuffer::init()
  98 {
  99         static Require _req(EXT_framebuffer_object);
 100
 101         width = 0;
 102         height = 0;
 103         status = FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT;
 104         dirty = 0;
 105
 106         if(ARB_direct_state_access)
 107                 glCreateFramebuffers(1, &id);
 108         else
 109                 glGenFramebuffers(1, &id);
 110 }
 111
 112 Framebuffer::~Framebuffer()
 113 {
 114         if(id)
 115                 glDeleteFramebuffers(1, &id);
 116 }
 117
 118 void Framebuffer::set_format(const FrameFormat &fmt)
 119 {
 120         if(!format.empty())
 121                 throw invalid_operation("Framebuffer::set_format");
 122         if(fmt.empty())
 123                 throw invalid_argument("Framebuffer::set_format");
 124
 125         format = fmt;
 126         attachments.resize(format.size());
 127 }
 128
 129 void Framebuffer::update() const
 130 {
 131         vector<GLenum> color_bufs;
 132         color_bufs.reserve(format.size());
 133         unsigned i = 0;
 134         for(const UInt16 *j=format.begin(); j!=format.end(); ++j, ++i)
 135         {
 136                 GLenum gl_attach_point = get_gl_attachment(static_cast<FrameAttachment>(*j));
 137                 if(dirty&(1<<i))
 138                 {
 139                         const Attachment &attch = attachments[i];
 140                         if(attch.tex)
 141                         {
 142                                 GLenum type = attch.tex->get_target();
 143                                 if(ARB_direct_state_access)
 144                                 {
 145                                         if(type==GL_TEXTURE_2D || type==GL_TEXTURE_2D_MULTISAMPLE || attch.layer<0)
 146                                                 glNamedFramebufferTexture(id, gl_attach_point, attch.tex->get_id(), attch.level);
 147                                         else
 148                                                 glNamedFramebufferTextureLayer(id, gl_attach_point, attch.tex->get_id(), attch.level, attch.layer);
 149                                 }
 150                                 else if(type==GL_TEXTURE_2D || type==GL_TEXTURE_2D_MULTISAMPLE)
 151                                         glFramebufferTexture2D(GL_FRAMEBUFFER, gl_attach_point, type, attch.tex->get_id(), attch.level);
 152                                 else if(attch.layer<0)
 153                                         glFramebufferTexture(GL_FRAMEBUFFER, gl_attach_point, attch.tex->get_id(), attch.level);
 154                                 else if(type==GL_TEXTURE_2D_ARRAY)
 155                                         glFramebufferTextureLayer(GL_FRAMEBUFFER, gl_attach_point, attch.tex->get_id(), attch.level, attch.layer);
 156                                 else if(type==GL_TEXTURE_3D)
 157                                         glFramebufferTexture3D(GL_FRAMEBUFFER, gl_attach_point, type, attch.tex->get_id(), attch.level, attch.layer);
 158                                 else if(type==GL_TEXTURE_CUBE_MAP)
 159                                         glFramebufferTexture2D(GL_FRAMEBUFFER, gl_attach_point, TextureCube::enumerate_faces(attch.layer), attch.tex->get_id(), attch.level);
 160                         }
 161                         else if(ARB_direct_state_access)
 162                                 glNamedFramebufferTexture(id, gl_attach_point, 0, 0);
 163                         else
 164                                 glFramebufferTexture2D(GL_FRAMEBUFFER, gl_attach_point, GL_TEXTURE_2D, 0, 0);
 165                 }
 166
 167                 if(gl_attach_point!=GL_DEPTH_ATTACHMENT && gl_attach_point!=GL_STENCIL_ATTACHMENT)
 168                         color_bufs.push_back(gl_attach_point);
 169         }
 170
 171         if(color_bufs.size()>1)
 172                 static Require _req(ARB_draw_buffers);
 173
 174         GLenum first_buffer = (color_bufs.empty() ? GL_NONE : color_bufs.front());
 175         if(ARB_direct_state_access)
 176         {
 177                 /* ARB_direct_state_access ties the availability of these functions to
 178                 framebuffers themselves, so no further checks are needed. */
 179                 glNamedFramebufferDrawBuffers(id, color_bufs.size(), &color_bufs[0]);
 180                 glNamedFramebufferReadBuffer(id, first_buffer);
 181         }
 182         else
 183         {
 184                 if(ARB_draw_buffers)
 185                         glDrawBuffers(color_bufs.size(), &color_bufs[0]);
 186                 else if(MSP_buffer_control)
 187                         glDrawBuffer(first_buffer);
 188
 189                 if(MSP_buffer_control)
 190                         glReadBuffer(first_buffer);
 191         }
 192
 193         if(ARB_direct_state_access)
 194                 status = static_cast<FramebufferStatus>(glCheckNamedFramebufferStatus(id, GL_FRAMEBUFFER));
 195         else
 196                 status = static_cast<FramebufferStatus>(glCheckFramebufferStatus(GL_FRAMEBUFFER));
 197
 198         dirty = 0;
 199 }
 200
 201 void Framebuffer::check_size()
 202 {
 203         for(vector<Attachment>::iterator i=attachments.begin(); i!=attachments.end(); ++i)
 204                 if(i->tex)
 205                 {
 206                         GLenum type = i->tex->get_target();
 207                         if(type==GL_TEXTURE_2D)
 208                         {
 209                                 Texture2D *tex = static_cast<Texture2D *>(i->tex);
 210                                 width = max(tex->get_width()>>i->level, 1U);
 211                                 height = max(tex->get_height()>>i->level, 1U);
 212                         }
 213                         else if(type==GL_TEXTURE_2D_MULTISAMPLE)
 214                         {
 215                                 Texture2DMultisample *tex = static_cast<Texture2DMultisample *>(i->tex);
 216                                 width = tex->get_width();
 217                                 height = tex->get_height();
 218                         }
 219                         else if(type==GL_TEXTURE_3D || type==GL_TEXTURE_2D_ARRAY)
 220                         {
 221                                 Texture3D *tex = static_cast<Texture3D *>(i->tex);
 222                                 width = max(tex->get_width()>>i->level, 1U);
 223                                 height = max(tex->get_height()>>i->level, 1U);
 224                         }
 225                         else if(type==GL_TEXTURE_CUBE_MAP)
 226                         {
 227                                 width = max(static_cast<TextureCube *>(i->tex)->get_size()>>i->level, 1U);
 228                                 height = width;
 229                         }
 230                         break;
 231                 }
 232
 233 }
 234
 235 void Framebuffer::set_attachment(FrameAttachment attch, Texture &tex, unsigned level, int layer, unsigned samples)
 236 {
 237         if(format.empty() || !id)
 238                 throw invalid_operation("Framebuffer::attach");
 239
 240         if((format.get_samples()>1 && samples!=format.get_samples()) || (format.get_samples()==1 && samples))
 241                 throw incompatible_data("Framebuffer::attach");
 242
 243         unsigned i = 0;
 244         for(const UInt16 *j=format.begin(); j!=format.end(); ++j, ++i)
 245                 if(*j==attch)
 246                 {
 247                         attachments[i].set(tex, level, layer);
 248                         dirty |= 1<<i;
 249                         check_size();
 250                         return;
 251                 }
 252
 253         throw incompatible_data("Framebuffer::attach");
 254 }
 255
 256 void Framebuffer::attach(FrameAttachment attch, Texture2D &tex, unsigned level)
 257 {
 258         tex.allocate(level);
 259         set_attachment(make_typed_attachment(attch, tex.get_format()), tex, level, 0, 0);
 260 }
 261
 262 void Framebuffer::attach(FrameAttachment attch, Texture2DMultisample &tex)
 263 {
 264         set_attachment(make_typed_attachment(attch, tex.get_format()), tex, 0, 0, tex.get_samples());
 265 }
 266
 267 void Framebuffer::attach(FrameAttachment attch, Texture3D &tex, unsigned layer, unsigned level)
 268 {
 269         tex.allocate(level);
 270         set_attachment(make_typed_attachment(attch, tex.get_format()), tex, level, layer, 0);
 271 }
 272
 273 void Framebuffer::attach(FrameAttachment attch, TextureCube &tex, TextureCubeFace face, unsigned level)
 274 {
 275         tex.allocate(level);
 276         set_attachment(make_typed_attachment(attch, tex.get_format()), tex, level, TextureCube::get_face_index(face), 0);
 277 }
 278
 279 void Framebuffer::attach_layered(FrameAttachment attch, Texture3D &tex, unsigned level)
 280 {
 281         static Require _req(ARB_geometry_shader4);
 282         tex.allocate(level);
 283         set_attachment(make_typed_attachment(attch, tex.get_format()), tex, level, -1, 0);
 284 }
 285
 286 void Framebuffer::attach_layered(FrameAttachment attch, TextureCube &tex, unsigned level)
 287 {
 288         static Require _req(ARB_geometry_shader4);
 289         tex.allocate(level);
 290         set_attachment(make_typed_attachment(attch, tex.get_format()), tex, level, -1, 0);
 291 }
 292
 293 void Framebuffer::detach(FrameAttachment attch)
 294 {
 295         if(!id)
 296                 throw invalid_operation("Framebuffer::detach");
 297
 298         int i = format.index(attch);
 299         if(i>=0)
 300         {
 301                 attachments[i].clear();
 302                 dirty |= 1<<i;
 303                 check_size();
 304         }
 305 }
 306
 307 void Framebuffer::resize(const WindowView &view)
 308 {
 309         if(id)
 310                 throw invalid_operation("Framebuffer::resize");
 311
 312         width = view.get_width();
 313         height = view.get_height();
 314 }
 315
 316 void Framebuffer::require_complete() const
 317 {
 318         if(status!=FRAMEBUFFER_COMPLETE)
 319                 throw framebuffer_incomplete(status);
 320 }
 321
 322 void Framebuffer::set_debug_name(const string &name)
 323 {
 324 #ifdef DEBUG
 325         if(KHR_debug)
 326                 glObjectLabel(GL_FRAMEBUFFER, id, name.size(), name.c_str());
 327 #else
 328         (void)name;
 329 #endif
 330 }
 331
 332 Framebuffer &Framebuffer::system()
 333 {
 334         static Framebuffer sys_framebuf(0);
 335         return sys_framebuf;
 336 }
 337
 338
 339 Framebuffer::Attachment::Attachment():
 340         tex(0),
 341         level(0),
 342         layer(0)
 343 { }
 344
 345 void Framebuffer::Attachment::set(Texture &t, unsigned l, int z)
 346 {
 347         tex = &t;
 348         level = l;
 349         layer = z;
 350 }
 351
 352 void Framebuffer::Attachment::clear()
 353 {
 354         tex = 0;
 355 }
 356
 357 } // namespace GL
 358 } // namespace Msp