src/mesa/pipe/softpipe/sp_winsys.h

   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 #ifndef SP_WINSYS_H
  29 #define SP_WINSYS_H
  30
  31 #include "main/mtypes.h"
  32
  33 /* This is the interface that softpipe requires any window system
  34  * hosting it to implement.  This is the only include file in softpipe
  35  * which is public.
  36  */
  37
  38
  39 /* Pipe drivers are (meant to be!) independent of both GL and the
  40  * window system.  The window system provides a buffer manager and a
  41  * set of additional hooks for things like command buffer submission,
  42  * etc.
  43  *
  44  * There clearly has to be some agreement between the window system
  45  * driver and the hardware driver about the format of command buffers,
  46  * etc.
  47  */
  48
  49 struct pipe_buffer_handle;
  50
  51 struct softpipe_winsys {
  52
  53    /* Do any special operations to ensure frontbuffer contents are
  54     * displayed, eg copy fake frontbuffer.
  55     */
  56    void (*flush_frontbuffer)( struct softpipe_winsys *sws );
  57
  58    /* Wait for any hw swapbuffers, etc. to finish:
  59     */
  60    void (*wait_idle)( struct softpipe_winsys *sws );
  61
  62    /* debug output
  63     */
  64    void (*printf)( struct softpipe_winsys *sws,
  65                    const char *, ... );
  66
  67
  68    /* The buffer manager is modeled after the dri_bugmgr interface,
  69     * but this is the subset that softpipe cares about.  Remember that
  70     * softpipe gets to choose the interface it needs, and the window
  71     * systems must then implement that interface (rather than the
  72     * other way around...).
  73     *
  74     * Softpipe only really wants to make system memory allocations,
  75     * right??
  76     */
  77    struct pipe_buffer_handle *(*create_buffer)(struct softpipe_winsys *sws,
  78                                                unsigned alignment );
  79
  80    void *(*buffer_map)( struct softpipe_winsys *sws,
  81                         struct pipe_buffer_handle *buf );
  82
  83    void (*buffer_unmap)( struct softpipe_winsys *sws,
  84                          struct pipe_buffer_handle *buf );
  85
  86    struct pipe_buffer_handle *(*buffer_reference)( struct softpipe_winsys *sws,
  87                                                    struct pipe_buffer_handle *buf );
  88
  89    void (*buffer_unreference)( struct softpipe_winsys *sws,
  90                                struct pipe_buffer_handle **buf );
  91
  92    void (*buffer_data)(struct softpipe_winsys *sws,
  93                        struct pipe_buffer_handle *buf,
  94                        unsigned size, const void *data );
  95
  96    void (*buffer_subdata)(struct softpipe_winsys *sws,
  97                           struct pipe_buffer_handle *buf,
  98                           unsigned long offset,
  99                           unsigned long size,
 100                           const void *data);
 101
 102    void (*buffer_get_subdata)(struct softpipe_winsys *sws,
 103                               struct pipe_buffer_handle *buf,
 104                               unsigned long offset,
 105                               unsigned long size,
 106                               void *data);
 107 };
 108
 109
 110 struct pipe_context *softpipe_create( struct softpipe_winsys * );
 111
 112
 113 #endif /* SP_WINSYS_H */