src/mesa/state_tracker/st_cb_flush.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 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   * Authors:
  30   *   Keith Whitwell <keith@tungstengraphics.com>
  31   *   Brian Paul
  32   */
  33
  34 #include "main/glheader.h"
  35 #include "main/macros.h"
  36 #include "main/context.h"
  37 #include "st_context.h"
  38 #include "st_cb_bitmap.h"
  39 #include "st_cb_flush.h"
  40 #include "st_cb_clear.h"
  41 #include "st_cb_fbo.h"
  42 #include "st_public.h"
  43 #include "pipe/p_context.h"
  44 #include "pipe/p_defines.h"
  45 #include "pipe/p_screen.h"
  46 #include "util/u_gen_mipmap.h"
  47 #include "util/u_blit.h"
  48
  49
  50 /** Check if we have a front color buffer and if it's been drawn to. */
  51 static INLINE GLboolean
  52 is_front_buffer_dirty(struct st_context *st)
  53 {
  54    if (st->frontbuffer_status == FRONT_STATUS_DIRTY) {
  55       return GL_TRUE;
  56    }
  57    else {
  58       GLframebuffer *fb = st->ctx->DrawBuffer;
  59       struct st_renderbuffer *strb
  60          = st_renderbuffer(fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer);
  61       return strb && strb->defined;
  62    }
  63 }
  64
  65
  66 /**
  67  * Tell the screen to display the front color buffer on-screen.
  68  */
  69 static void
  70 display_front_buffer(struct st_context *st)
  71 {
  72    GLframebuffer *fb = st->ctx->DrawBuffer;
  73    struct st_renderbuffer *strb
  74       = st_renderbuffer(fb->Attachment[BUFFER_FRONT_LEFT].Renderbuffer);
  75
  76    if (strb) {
  77       struct pipe_surface *front_surf = strb->surface;
  78
  79       /* Hook for copying "fake" frontbuffer if necessary:
  80        */
  81       st->pipe->screen->flush_frontbuffer( st->pipe->screen, front_surf,
  82                                            st->pipe->priv );
  83
  84       /*
  85         st->frontbuffer_status = FRONT_STATUS_UNDEFINED;
  86       */
  87    }
  88 }
  89
  90
  91 void st_flush( struct st_context *st, uint pipeFlushFlags,
  92                struct pipe_fence_handle **fence )
  93 {
  94    FLUSH_CURRENT(st->ctx, 0);
  95
  96    /* Release any vertex buffers that might potentially be accessed in
  97     * successive frames:
  98     */
  99    st_flush_bitmap(st);
 100    st_flush_clear(st);
 101    util_blit_flush(st->blit);
 102    util_gen_mipmap_flush(st->gen_mipmap);
 103
 104    st->pipe->flush( st->pipe, pipeFlushFlags, fence );
 105
 106    if ((pipeFlushFlags & PIPE_FLUSH_FRAME) &&
 107        is_front_buffer_dirty(st))
 108       display_front_buffer(st);
 109 }
 110
 111
 112 /**
 113  * Flush, and wait for completion.
 114  */
 115 void st_finish( struct st_context *st )
 116 {
 117    struct pipe_fence_handle *fence = NULL;
 118
 119    st_flush(st, PIPE_FLUSH_RENDER_CACHE | PIPE_FLUSH_FRAME, &fence);
 120
 121    if(fence) {
 122       st->pipe->screen->fence_finish(st->pipe->screen, fence, 0);
 123       st->pipe->screen->fence_reference(st->pipe->screen, &fence, NULL);
 124    }
 125 }
 126
 127
 128
 129 /**
 130  * Called via ctx->Driver.Flush()
 131  */
 132 static void st_glFlush(GLcontext *ctx)
 133 {
 134    struct st_context *st = ctx->st;
 135
 136    /* Don't call st_finish() here.  It is not the state tracker's
 137     * responsibilty to inject sleeps in the hope of avoiding buffer
 138     * synchronization issues.  Calling finish() here will just hide
 139     * problems that need to be fixed elsewhere.
 140     */
 141    st_flush(st, PIPE_FLUSH_RENDER_CACHE | PIPE_FLUSH_FRAME, NULL);
 142 }
 143
 144
 145 /**
 146  * Called via ctx->Driver.Finish()
 147  */
 148 static void st_glFinish(GLcontext *ctx)
 149 {
 150    struct st_context *st = ctx->st;
 151
 152    st_finish(st);
 153 }
 154
 155
 156 void st_init_flush_functions(struct dd_function_table *functions)
 157 {
 158    functions->Flush = st_glFlush;
 159    functions->Finish = st_glFinish;
 160
 161    /* Windows opengl32.dll calls glFinish prior to every swapbuffers.
 162     * This is unnecessary and degrades performance.  Luckily we have some
 163     * scope to work around this, as the externally-visible behaviour of
 164     * Finish() is identical to Flush() in all cases - no differences in
 165     * rendering or ReadPixels are visible if we opt not to wait here.
 166     *
 167     * Only set this up on windows to avoid suprise elsewhere.
 168     */
 169 #ifdef PIPE_OS_WINDOWS
 170    functions->Finish = st_glFlush;
 171 #endif
 172 }