src/mesa/state_tracker/st_framebuffer.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2003 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28
  29 #include "main/imports.h"
  30 #include "main/buffers.h"
  31 #include "main/context.h"
  32 #include "main/framebuffer.h"
  33 #include "main/matrix.h"
  34 #include "main/renderbuffer.h"
  35 #include "main/scissor.h"
  36 #include "main/viewport.h"
  37 #include "st_context.h"
  38 #include "st_cb_fbo.h"
  39 #include "st_public.h"
  40 #include "pipe/p_defines.h"
  41 #include "pipe/p_context.h"
  42
  43
  44 struct st_framebuffer *
  45 st_create_framebuffer( const __GLcontextModes *visual,
  46                        enum pipe_format colorFormat,
  47                        enum pipe_format depthFormat,
  48                        enum pipe_format stencilFormat,
  49                        uint width, uint height,
  50                        void *private)
  51 {
  52    struct st_framebuffer *stfb = ST_CALLOC_STRUCT(st_framebuffer);
  53    if (stfb) {
  54       int samples = st_get_msaa();
  55
  56       if (visual->sampleBuffers)
  57          samples = visual->samples;
  58
  59       _mesa_initialize_framebuffer(&stfb->Base, visual);
  60
  61       if (visual->doubleBufferMode) {
  62          struct gl_renderbuffer *rb
  63             = st_new_renderbuffer_fb(colorFormat, samples, FALSE);
  64          _mesa_add_renderbuffer(&stfb->Base, BUFFER_BACK_LEFT, rb);
  65       }
  66       else {
  67          /* Only allocate front buffer right now if we're single buffered.
  68           * If double-buffered, allocate front buffer on demand later.
  69           * See check_create_front_buffers() and st_set_framebuffer_surface().
  70           */
  71          struct gl_renderbuffer *rb
  72             = st_new_renderbuffer_fb(colorFormat, samples, FALSE);
  73          _mesa_add_renderbuffer(&stfb->Base, BUFFER_FRONT_LEFT, rb);
  74       }
  75
  76       if (depthFormat == stencilFormat && depthFormat != PIPE_FORMAT_NONE) {
  77          /* combined depth/stencil buffer */
  78          struct gl_renderbuffer *depthStencilRb
  79             = st_new_renderbuffer_fb(depthFormat, samples, FALSE);
  80          /* note: bind RB to two attachment points */
  81          _mesa_add_renderbuffer(&stfb->Base, BUFFER_DEPTH, depthStencilRb);
  82          _mesa_add_renderbuffer(&stfb->Base, BUFFER_STENCIL, depthStencilRb);
  83       }
  84       else {
  85          /* separate depth and/or stencil */
  86
  87          if (visual->depthBits == 32) {
  88             /* 32-bit depth buffer */
  89             struct gl_renderbuffer *depthRb
  90                = st_new_renderbuffer_fb(depthFormat, samples, FALSE);
  91             _mesa_add_renderbuffer(&stfb->Base, BUFFER_DEPTH, depthRb);
  92          }
  93          else if (visual->depthBits == 24) {
  94             /* 24-bit depth buffer, ignore stencil bits */
  95             struct gl_renderbuffer *depthRb
  96                = st_new_renderbuffer_fb(depthFormat, samples, FALSE);
  97             _mesa_add_renderbuffer(&stfb->Base, BUFFER_DEPTH, depthRb);
  98          }
  99          else if (visual->depthBits > 0) {
 100             /* 16-bit depth buffer */
 101             struct gl_renderbuffer *depthRb
 102                = st_new_renderbuffer_fb(depthFormat, samples, FALSE);
 103             _mesa_add_renderbuffer(&stfb->Base, BUFFER_DEPTH, depthRb);
 104          }
 105
 106          if (visual->stencilBits > 0) {
 107             /* 8-bit stencil */
 108             struct gl_renderbuffer *stencilRb
 109                = st_new_renderbuffer_fb(stencilFormat, samples, FALSE);
 110             _mesa_add_renderbuffer(&stfb->Base, BUFFER_STENCIL, stencilRb);
 111          }
 112       }
 113
 114       if (visual->accumRedBits > 0) {
 115          /* 16-bit/channel accum */
 116          /* TODO: query the pipe screen for accumulation buffer format support */
 117          struct gl_renderbuffer *accumRb
 118             = st_new_renderbuffer_fb(PIPE_FORMAT_R16G16B16A16_SNORM, 0, TRUE);
 119          _mesa_add_renderbuffer(&stfb->Base, BUFFER_ACCUM, accumRb);
 120       }
 121
 122       stfb->Base.Initialized = GL_TRUE;
 123       stfb->InitWidth = width;
 124       stfb->InitHeight = height;
 125       stfb->Private = private;
 126    }
 127    return stfb;
 128 }
 129
 130
 131 void st_resize_framebuffer( struct st_framebuffer *stfb,
 132                             uint width, uint height )
 133 {
 134    if (stfb->Base.Width != width || stfb->Base.Height != height) {
 135       GET_CURRENT_CONTEXT(ctx);
 136       if (ctx) {
 137          _mesa_check_init_viewport(ctx, width, height);
 138
 139          _mesa_resize_framebuffer(ctx, &stfb->Base, width, height);
 140
 141          assert(stfb->Base.Width == width);
 142          assert(stfb->Base.Height == height);
 143       }
 144    }
 145 }
 146
 147
 148 void st_unreference_framebuffer( struct st_framebuffer *stfb )
 149 {
 150    _mesa_reference_framebuffer((struct gl_framebuffer **) &stfb, NULL);
 151 }
 152
 153
 154
 155 /**
 156  * Set/replace a framebuffer surface.
 157  * The user of the state tracker can use this instead of
 158  * st_resize_framebuffer() to provide new surfaces when a window is resized.
 159  */
 160 void
 161 st_set_framebuffer_surface(struct st_framebuffer *stfb,
 162                            uint surfIndex, struct pipe_surface *surf)
 163 {
 164    GET_CURRENT_CONTEXT(ctx);
 165    static const GLuint invalid_size = 9999999;
 166    struct st_renderbuffer *strb;
 167    GLuint width, height, i;
 168
 169    assert(surfIndex < BUFFER_COUNT);
 170
 171    strb = st_renderbuffer(stfb->Base.Attachment[surfIndex].Renderbuffer);
 172
 173    if (!strb) {
 174       if (surfIndex == ST_SURFACE_FRONT_LEFT) {
 175          /* Delayed creation when the window system supplies a fake front buffer */
 176          struct st_renderbuffer *strb_back
 177             = st_renderbuffer(stfb->Base.Attachment[ST_SURFACE_BACK_LEFT].Renderbuffer);
 178          struct gl_renderbuffer *rb
 179             = st_new_renderbuffer_fb(surf->format, strb_back->Base.NumSamples, FALSE);
 180          _mesa_add_renderbuffer(&stfb->Base, BUFFER_FRONT_LEFT, rb);
 181          strb = st_renderbuffer(rb);
 182       } else {
 183          /* fail */
 184          return;
 185       }
 186    }
 187
 188    /* replace the renderbuffer's surface/texture pointers */
 189    pipe_surface_reference( &strb->surface, surf );
 190    pipe_texture_reference( &strb->texture, surf->texture );
 191
 192    if (ctx) {
 193       /* If ctx isn't set, we've likely not made current yet.
 194        * But when we do, we need to start setting this dirty bit
 195        * to ensure the renderbuffer attachements are up-to-date
 196        * via update_framebuffer.
 197        */
 198       ctx->st->dirty.st |= ST_NEW_FRAMEBUFFER;
 199    }
 200
 201    /* update renderbuffer's width/height */
 202    strb->Base.Width = surf->width;
 203    strb->Base.Height = surf->height;
 204
 205    /* Try to update the framebuffer's width/height from the renderbuffer
 206     * sizes.  Before we start drawing, all the rbs _should_ be the same size.
 207     */
 208    width = height = invalid_size;
 209    for (i = 0; i < BUFFER_COUNT; i++) {
 210       if (stfb->Base.Attachment[i].Renderbuffer) {
 211          if (width == invalid_size) {
 212             width = stfb->Base.Attachment[i].Renderbuffer->Width;
 213             height = stfb->Base.Attachment[i].Renderbuffer->Height;
 214          }
 215          else if (width != stfb->Base.Attachment[i].Renderbuffer->Width ||
 216                   height != stfb->Base.Attachment[i].Renderbuffer->Height) {
 217             /* inconsistant renderbuffer sizes, bail out */
 218             return;
 219          }
 220       }
 221    }
 222
 223    if (width != invalid_size) {
 224       /* OK, the renderbuffers are of a consistant size, so update the
 225        * parent framebuffer's size.
 226        */
 227       stfb->Base.Width = width;
 228       stfb->Base.Height = height;
 229    }
 230 }
 231
 232
 233
 234 /**
 235  * Return the pipe_surface for the given renderbuffer.
 236  */
 237 int
 238 st_get_framebuffer_surface(struct st_framebuffer *stfb, uint surfIndex, struct pipe_surface **surface)
 239 {
 240    struct st_renderbuffer *strb;
 241
 242    assert(surfIndex <= ST_SURFACE_DEPTH);
 243
 244    /* sanity checks, ST tokens should match Mesa tokens */
 245    assert(ST_SURFACE_FRONT_LEFT == BUFFER_FRONT_LEFT);
 246    assert(ST_SURFACE_BACK_RIGHT == BUFFER_BACK_RIGHT);
 247
 248    strb = st_renderbuffer(stfb->Base.Attachment[surfIndex].Renderbuffer);
 249    if (strb) {
 250       *surface = strb->surface;
 251       return GL_TRUE;
 252    }
 253
 254    *surface = NULL;
 255    return GL_FALSE;
 256 }
 257
 258 int
 259 st_get_framebuffer_texture(struct st_framebuffer *stfb, uint surfIndex, struct pipe_texture **texture)
 260 {
 261    struct st_renderbuffer *strb;
 262
 263    assert(surfIndex <= ST_SURFACE_DEPTH);
 264
 265    /* sanity checks, ST tokens should match Mesa tokens */
 266    assert(ST_SURFACE_FRONT_LEFT == BUFFER_FRONT_LEFT);
 267    assert(ST_SURFACE_BACK_RIGHT == BUFFER_BACK_RIGHT);
 268
 269    strb = st_renderbuffer(stfb->Base.Attachment[surfIndex].Renderbuffer);
 270    if (strb) {
 271       *texture = strb->texture;
 272       return GL_TRUE;
 273    }
 274
 275    *texture = NULL;
 276    return GL_FALSE;
 277 }
 278
 279 /**
 280  * This function is to be called prior to SwapBuffers on the given
 281  * framebuffer.  It checks if the current context is bound to the framebuffer
 282  * and flushes rendering if needed.
 283  */
 284 void
 285 st_notify_swapbuffers(struct st_framebuffer *stfb)
 286 {
 287    GET_CURRENT_CONTEXT(ctx);
 288
 289    if (ctx && ctx->DrawBuffer == &stfb->Base) {
 290       st_flush( ctx->st,
 291                 PIPE_FLUSH_RENDER_CACHE |
 292                 PIPE_FLUSH_SWAPBUFFERS |
 293                 PIPE_FLUSH_FRAME,
 294                 NULL );
 295       if (st_renderbuffer(stfb->Base.Attachment[BUFFER_BACK_LEFT].Renderbuffer))
 296          ctx->st->frontbuffer_status = FRONT_STATUS_COPY_OF_BACK;
 297    }
 298 }
 299
 300
 301 /**
 302  * Swap the front/back color buffers.  Exchange the front/back pointers
 303  * and update some derived state.
 304  * No need to call st_notify_swapbuffers() first.
 305  *
 306  * For a single-buffered framebuffer, no swap occurs, but we still return
 307  * the pointer(s) to the front color buffer(s).
 308  *
 309  * \param front_left  returns pointer to front-left renderbuffer after swap
 310  * \param front_right  returns pointer to front-right renderbuffer after swap
 311  */
 312 void
 313 st_swapbuffers(struct st_framebuffer *stfb,
 314                struct pipe_surface **front_left,
 315                struct pipe_surface **front_right)
 316 {
 317    struct gl_framebuffer *fb = &stfb->Base;
 318
 319    GET_CURRENT_CONTEXT(ctx);
 320
 321    if (ctx && ctx->DrawBuffer == &stfb->Base) {
 322       st_flush( ctx->st,
 323                 PIPE_FLUSH_RENDER_CACHE |
 324                 PIPE_FLUSH_SWAPBUFFERS |
 325                 PIPE_FLUSH_FRAME,
 326                 NULL );
 327    }
 328
 329    if (!fb->Visual.doubleBufferMode) {
 330       /* single buffer mode - return pointers to front surfaces */
 331       if (front_left) {
 332          struct st_renderbuffer *strb =
 333             st_renderbuffer(fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer);
 334          *front_left = strb->surface;
 335       }
 336       if (front_right) {
 337          struct st_renderbuffer *strb =
 338             st_renderbuffer(fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer);
 339          *front_right = strb ? strb->surface : NULL;
 340       }
 341       return;
 342    }
 343
 344    /* swap left buffers */
 345    if (fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer &&
 346        fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer) {
 347       struct gl_renderbuffer *rbTemp;
 348       rbTemp = fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer;
 349       fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer =
 350          fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer;
 351       fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer = rbTemp;
 352       if (front_left) {
 353          struct st_renderbuffer *strb =
 354             st_renderbuffer(fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer);
 355          *front_left = strb->surface;
 356       }
 357       /* mark back buffer contents as undefined */
 358       {
 359          struct st_renderbuffer *back =
 360             st_renderbuffer(fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer);
 361          back->defined = GL_FALSE;
 362       }
 363    }
 364    else {
 365       /* no front buffer, display the back buffer */
 366       if (front_left) {
 367          struct st_renderbuffer *strb =
 368             st_renderbuffer(fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer);
 369          *front_left = strb->surface;
 370       }
 371    }
 372
 373    /* swap right buffers (for stereo) */
 374    if (fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer &&
 375        fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer) {
 376       struct gl_renderbuffer *rbTemp;
 377       rbTemp = fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer;
 378       fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer =
 379          fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer;
 380       fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer = rbTemp;
 381       if (front_right) {
 382          struct st_renderbuffer *strb =
 383             st_renderbuffer(fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer);
 384          *front_right = strb->surface;
 385       }
 386       /* mark back buffer contents as undefined */
 387       {
 388          struct st_renderbuffer *back =
 389             st_renderbuffer(fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer);
 390          back->defined = GL_FALSE;
 391       }
 392    }
 393    else {
 394       /* no front right buffer, display back right buffer (if exists) */
 395       if (front_right) {
 396          struct st_renderbuffer *strb =
 397             st_renderbuffer(fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer);
 398          *front_right = strb ? strb->surface : NULL;
 399       }
 400    }
 401
 402    /* Update the _ColorDrawBuffers[] array and _ColorReadBuffer pointer */
 403    _mesa_update_framebuffer(ctx);
 404
 405    /* Make sure we draw into the new back surface */
 406    st_invalidate_state(ctx, _NEW_BUFFERS);
 407 }
 408
 409
 410 void *st_framebuffer_private( struct st_framebuffer *stfb )
 411 {
 412    return stfb->Private;
 413 }
 414
 415 void st_get_framebuffer_dimensions( struct st_framebuffer *stfb,
 416                                     uint *width,
 417                                     uint *height)
 418 {
 419    *width = stfb->Base.Width;
 420    *height = stfb->Base.Height;
 421 }