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