src/gallium/auxiliary/util/u_simple_screen.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 VMware, Inc.
   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 U_SIMPLE_SCREEN_H
  29 #define U_SIMPLE_SCREEN_H
  30
  31 #include "pipe/p_format.h"
  32
  33 struct pipe_screen;
  34 struct pipe_fence_handle;
  35 struct pipe_surface;
  36 struct pipe_resource;
  37
  38 /**
  39  * Gallium3D 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 struct pipe_winsys
  49 {
  50    void (*destroy)( struct pipe_winsys *ws );
  51
  52    /** Returns name of this winsys interface */
  53    const char *(*get_name)( struct pipe_winsys *ws );
  54
  55    /**
  56     * Do any special operations to ensure frontbuffer contents are
  57     * displayed, eg copy fake frontbuffer.
  58     */
  59    void (*flush_frontbuffer)( struct pipe_winsys *ws,
  60                               struct pipe_resource *resource,
  61                               unsigned level, unsigned layer,
  62                               void *context_private );
  63
  64
  65    /**
  66     * Buffer management. Buffer attributes are mostly fixed over its lifetime.
  67     *
  68     * Remember that gallium gets to choose the interface it needs, and the
  69     * window systems must then implement that interface (rather than the
  70     * other way around...).
  71     *
  72     * usage is a bitmask of PIPE_BIND_*.
  73     * All possible usages must be present.
  74     *
  75     * alignment indicates the client's alignment requirements, eg for
  76     * SSE instructions.
  77     */
  78    struct pipe_resource *(*buffer_create)( struct pipe_winsys *ws,
  79                                          unsigned alignment,
  80                                          unsigned usage,
  81                                          unsigned size );
  82
  83    /**
  84     * Create a buffer that wraps user-space data.
  85     *
  86     * Effectively this schedules a delayed call to buffer_create
  87     * followed by an upload of the data at *some point in the future*,
  88     * or perhaps never.  Basically the allocate/upload is delayed
  89     * until the buffer is actually passed to hardware.
  90     *
  91     * The intention is to provide a quick way to turn regular data
  92     * into a buffer, and secondly to avoid a copy operation if that
  93     * data subsequently turns out to be only accessed by the CPU.
  94     *
  95     * Common example is OpenGL vertex buffers that are subsequently
  96     * processed either by software TNL in the driver or by passing to
  97     * hardware.
  98     *
  99     * XXX: What happens if the delayed call to buffer_create() fails?
 100     *
 101     * Note that ptr may be accessed at any time upto the time when the
 102     * buffer is destroyed, so the data must not be freed before then.
 103     */
 104    struct pipe_resource *(*user_buffer_create)(struct pipe_winsys *ws,
 105                                                     void *ptr,
 106                                                     unsigned bytes);
 107
 108    /**
 109     * Allocate storage for a display target surface.
 110     *
 111     * Often surfaces which are meant to be blitted to the front screen (i.e.,
 112     * display targets) must be allocated with special characteristics, memory
 113     * pools, or obtained directly from the windowing system.
 114     *
 115     * This callback is invoked by the pipe_screen when creating a texture marked
 116     * with the PIPE_BIND_DISPLAY_TARGET flag  to get the underlying
 117     * buffer storage.
 118     */
 119    struct pipe_resource *(*surface_buffer_create)(struct pipe_winsys *ws,
 120                                                 unsigned width, unsigned height,
 121                                                 enum pipe_format format,
 122                                                 unsigned usage,
 123                                                 unsigned tex_usage,
 124                                                 unsigned *stride);
 125
 126
 127    /**
 128     * Map the entire data store of a buffer object into the client's address.
 129     * flags is bitmask of PIPE_BUFFER_USAGE_CPU_READ/WRITE flags.
 130     */
 131    void *(*buffer_map)( struct pipe_winsys *ws,
 132                         struct pipe_resource *buf,
 133                         unsigned usage );
 134
 135    void (*buffer_unmap)( struct pipe_winsys *ws,
 136                          struct pipe_resource *buf );
 137
 138    void (*buffer_destroy)( struct pipe_resource *buf );
 139
 140
 141    /** Set ptr = fence, with reference counting */
 142    void (*fence_reference)( struct pipe_winsys *ws,
 143                             struct pipe_fence_handle **ptr,
 144                             struct pipe_fence_handle *fence );
 145
 146    /**
 147     * Checks whether the fence has been signalled.
 148     * \param flags  driver-specific meaning
 149     * \return zero on success.
 150     */
 151    int (*fence_signalled)( struct pipe_winsys *ws,
 152                            struct pipe_fence_handle *fence,
 153                            unsigned flag );
 154
 155    /**
 156     * Wait for the fence to finish.
 157     * \param flags  driver-specific meaning
 158     * \return zero on success.
 159     */
 160    int (*fence_finish)( struct pipe_winsys *ws,
 161                         struct pipe_fence_handle *fence,
 162                         unsigned flags,
 163                         uint64_t timeout );
 164
 165 };
 166
 167 /**
 168  * The following function initializes a simple passthrough screen.
 169  *
 170  * All the relevant screen function pointers will forwarded to the
 171  * winsys.
 172  */
 173 void u_simple_screen_init(struct pipe_screen *screen);
 174
 175 /**
 176  * Returns the name of the winsys associated with this screen.
 177  */
 178 const char* u_simple_screen_winsys_name(struct pipe_screen *screen);
 179
 180 #endif