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  * \param surfIndex  an ST_SURFACE_x index
 164  */
 165 void
 166 st_set_framebuffer_surface(struct st_framebuffer *stfb,
 167                            uint surfIndex, struct pipe_surface *surf)
 168 {
 169    GET_CURRENT_CONTEXT(ctx);
 170    static const GLuint invalid_size = 9999999;
 171    struct st_renderbuffer *strb;
 172    GLuint width, height, i;
 173
 174    /* sanity checks */
 175    assert(ST_SURFACE_FRONT_LEFT == BUFFER_FRONT_LEFT);
 176    assert(ST_SURFACE_BACK_LEFT == BUFFER_BACK_LEFT);
 177    assert(ST_SURFACE_FRONT_RIGHT == BUFFER_FRONT_RIGHT);
 178    assert(ST_SURFACE_BACK_RIGHT == BUFFER_BACK_RIGHT);
 179    assert(ST_SURFACE_DEPTH == BUFFER_DEPTH);
 180
 181    assert(surfIndex < BUFFER_COUNT);
 182
 183    strb = st_renderbuffer(stfb->Base.Attachment[surfIndex].Renderbuffer);
 184
 185    if (!strb) {
 186       if (surfIndex == ST_SURFACE_FRONT_LEFT) {
 187          /* Delayed creation when the window system supplies a fake front buffer */
 188          struct st_renderbuffer *strb_back
 189             = st_renderbuffer(stfb->Base.Attachment[ST_SURFACE_BACK_LEFT].Renderbuffer);
 190          struct gl_renderbuffer *rb
 191             = st_new_renderbuffer_fb(surf->format, strb_back->Base.NumSamples, FALSE);
 192          _mesa_add_renderbuffer(&stfb->Base, BUFFER_FRONT_LEFT, rb);
 193          strb = st_renderbuffer(rb);
 194       } else {
 195          /* fail */
 196          return;
 197       }
 198    }
 199
 200    /* replace the renderbuffer's surface/texture pointers */
 201    pipe_surface_reference( &strb->surface, surf );
 202    pipe_texture_reference( &strb->texture, surf->texture );
 203
 204    if (ctx) {
 205       /* If ctx isn't set, we've likely not made current yet.
 206        * But when we do, we need to start setting this dirty bit
 207        * to ensure the renderbuffer attachements are up-to-date
 208        * via update_framebuffer.
 209        */
 210       ctx->st->dirty.st |= ST_NEW_FRAMEBUFFER;
 211    }
 212
 213    /* update renderbuffer's width/height */
 214    strb->Base.Width = surf->width;
 215    strb->Base.Height = surf->height;
 216
 217    /* Try to update the framebuffer's width/height from the renderbuffer
 218     * sizes.  Before we start drawing, all the rbs _should_ be the same size.
 219     */
 220    width = height = invalid_size;
 221    for (i = 0; i < BUFFER_COUNT; i++) {
 222       if (stfb->Base.Attachment[i].Renderbuffer) {
 223          if (width == invalid_size) {
 224             width = stfb->Base.Attachment[i].Renderbuffer->Width;
 225             height = stfb->Base.Attachment[i].Renderbuffer->Height;
 226          }
 227          else if (width != stfb->Base.Attachment[i].Renderbuffer->Width ||
 228                   height != stfb->Base.Attachment[i].Renderbuffer->Height) {
 229             /* inconsistant renderbuffer sizes, bail out */
 230             return;
 231          }
 232       }
 233    }
 234
 235    if (width != invalid_size) {
 236       /* OK, the renderbuffers are of a consistant size, so update the
 237        * parent framebuffer's size.
 238        */
 239       stfb->Base.Width = width;
 240       stfb->Base.Height = height;
 241    }
 242 }
 243
 244
 245
 246 /**
 247  * Return the pipe_surface for the given renderbuffer.
 248  */
 249 int
 250 st_get_framebuffer_surface(struct st_framebuffer *stfb, uint surfIndex, struct pipe_surface **surface)
 251 {
 252    struct st_renderbuffer *strb;
 253
 254    assert(surfIndex <= ST_SURFACE_DEPTH);
 255
 256    /* sanity checks, ST tokens should match Mesa tokens */
 257    assert(ST_SURFACE_FRONT_LEFT == BUFFER_FRONT_LEFT);
 258    assert(ST_SURFACE_BACK_RIGHT == BUFFER_BACK_RIGHT);
 259
 260    strb = st_renderbuffer(stfb->Base.Attachment[surfIndex].Renderbuffer);
 261    if (strb) {
 262       *surface = strb->surface;
 263       return GL_TRUE;
 264    }
 265
 266    *surface = NULL;
 267    return GL_FALSE;
 268 }
 269
 270 int
 271 st_get_framebuffer_texture(struct st_framebuffer *stfb, uint surfIndex, struct pipe_texture **texture)
 272 {
 273    struct st_renderbuffer *strb;
 274
 275    assert(surfIndex <= ST_SURFACE_DEPTH);
 276
 277    /* sanity checks, ST tokens should match Mesa tokens */
 278    assert(ST_SURFACE_FRONT_LEFT == BUFFER_FRONT_LEFT);
 279    assert(ST_SURFACE_BACK_RIGHT == BUFFER_BACK_RIGHT);
 280
 281    strb = st_renderbuffer(stfb->Base.Attachment[surfIndex].Renderbuffer);
 282    if (strb) {
 283       *texture = strb->texture;
 284       return GL_TRUE;
 285    }
 286
 287    *texture = NULL;
 288    return GL_FALSE;
 289 }
 290
 291 /**
 292  * This function is to be called prior to SwapBuffers on the given
 293  * framebuffer.  It checks if the current context is bound to the framebuffer
 294  * and flushes rendering if needed.
 295  */
 296 void
 297 st_notify_swapbuffers(struct st_framebuffer *stfb)
 298 {
 299    GET_CURRENT_CONTEXT(ctx);
 300
 301    if (ctx && ctx->DrawBuffer == &stfb->Base) {
 302       st_flush( ctx->st,
 303                 PIPE_FLUSH_RENDER_CACHE |
 304                 PIPE_FLUSH_SWAPBUFFERS |
 305                 PIPE_FLUSH_FRAME,
 306                 NULL );
 307       if (st_renderbuffer(stfb->Base.Attachment[BUFFER_BACK_LEFT].Renderbuffer))
 308          ctx->st->frontbuffer_status = FRONT_STATUS_COPY_OF_BACK;
 309    }
 310 }
 311
 312
 313 /**
 314  * Swap the front/back color buffers.  Exchange the front/back pointers
 315  * and update some derived state.
 316  * No need to call st_notify_swapbuffers() first.
 317  *
 318  * For a single-buffered framebuffer, no swap occurs, but we still return
 319  * the pointer(s) to the front color buffer(s).
 320  *
 321  * \param front_left  returns pointer to front-left renderbuffer after swap
 322  * \param front_right  returns pointer to front-right renderbuffer after swap
 323  */
 324 void
 325 st_swapbuffers(struct st_framebuffer *stfb,
 326                struct pipe_surface **front_left,
 327                struct pipe_surface **front_right)
 328 {
 329    struct gl_framebuffer *fb = &stfb->Base;
 330
 331    GET_CURRENT_CONTEXT(ctx);
 332
 333    if (ctx && ctx->DrawBuffer == &stfb->Base) {
 334       st_flush( ctx->st,
 335                 PIPE_FLUSH_RENDER_CACHE |
 336                 PIPE_FLUSH_SWAPBUFFERS |
 337                 PIPE_FLUSH_FRAME,
 338                 NULL );
 339    }
 340
 341    if (!fb->Visual.doubleBufferMode) {
 342       /* single buffer mode - return pointers to front surfaces */
 343       if (front_left) {
 344          struct st_renderbuffer *strb =
 345             st_renderbuffer(fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer);
 346          *front_left = strb->surface;
 347       }
 348       if (front_right) {
 349          struct st_renderbuffer *strb =
 350             st_renderbuffer(fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer);
 351          *front_right = strb ? strb->surface : NULL;
 352       }
 353       return;
 354    }
 355
 356    /* swap left buffers */
 357    if (fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer &&
 358        fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer) {
 359       struct gl_renderbuffer *rbTemp;
 360       rbTemp = fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer;
 361       fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer =
 362          fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer;
 363       fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer = rbTemp;
 364       if (front_left) {
 365          struct st_renderbuffer *strb =
 366             st_renderbuffer(fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer);
 367          *front_left = strb->surface;
 368       }
 369       /* mark back buffer contents as undefined */
 370       {
 371          struct st_renderbuffer *back =
 372             st_renderbuffer(fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer);
 373          back->defined = GL_FALSE;
 374       }
 375    }
 376    else {
 377       /* no front buffer, display the back buffer */
 378       if (front_left) {
 379          struct st_renderbuffer *strb =
 380             st_renderbuffer(fb->Attachment[BUFFER_BACK_LEFT].Renderbuffer);
 381          *front_left = strb->surface;
 382       }
 383    }
 384
 385    /* swap right buffers (for stereo) */
 386    if (fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer &&
 387        fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer) {
 388       struct gl_renderbuffer *rbTemp;
 389       rbTemp = fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer;
 390       fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer =
 391          fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer;
 392       fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer = rbTemp;
 393       if (front_right) {
 394          struct st_renderbuffer *strb =
 395             st_renderbuffer(fb->Attachment[BUFFER_FRONT_RIGHT].Renderbuffer);
 396          *front_right = strb->surface;
 397       }
 398       /* mark back buffer contents as undefined */
 399       {
 400          struct st_renderbuffer *back =
 401             st_renderbuffer(fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer);
 402          back->defined = GL_FALSE;
 403       }
 404    }
 405    else {
 406       /* no front right buffer, display back right buffer (if exists) */
 407       if (front_right) {
 408          struct st_renderbuffer *strb =
 409             st_renderbuffer(fb->Attachment[BUFFER_BACK_RIGHT].Renderbuffer);
 410          *front_right = strb ? strb->surface : NULL;
 411       }
 412    }
 413
 414    /* Update the _ColorDrawBuffers[] array and _ColorReadBuffer pointer */
 415    _mesa_update_framebuffer(ctx);
 416
 417    /* Make sure we draw into the new back surface */
 418    st_invalidate_state(ctx, _NEW_BUFFERS);
 419 }
 420
 421
 422 void *st_framebuffer_private( struct st_framebuffer *stfb )
 423 {
 424    return stfb->Private;
 425 }
 426
 427 void st_get_framebuffer_dimensions( struct st_framebuffer *stfb,
 428                                     uint *width,
 429                                     uint *height)
 430 {
 431    *width = stfb->Base.Width;
 432    *height = stfb->Base.Height;
 433 }