src/gallium/include/pipe/p_screen.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 /**
  29  * @file
  30  *
  31  * Screen, Adapter or GPU
  32  *
  33  * These are driver functions/facilities that are context independent.
  34  */
  35
  36
  37 #ifndef P_SCREEN_H
  38 #define P_SCREEN_H
  39
  40
  41 #include "pipe/p_compiler.h"
  42 #include "pipe/p_format.h"
  43 #include "pipe/p_defines.h"
  44
  45
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51
  52 /** Opaque type */
  53 struct winsys_handle;
  54 /** Opaque type */
  55 struct pipe_fence_handle;
  56 struct pipe_winsys;
  57 struct pipe_resource;
  58 struct pipe_surface;
  59 struct pipe_transfer;
  60
  61
  62 /**
  63  * Gallium screen/adapter context.  Basically everything
  64  * hardware-specific that doesn't actually require a rendering
  65  * context.
  66  */
  67 struct pipe_screen {
  68    struct pipe_winsys *winsys;
  69
  70    void (*destroy)( struct pipe_screen * );
  71
  72
  73    const char *(*get_name)( struct pipe_screen * );
  74
  75    const char *(*get_vendor)( struct pipe_screen * );
  76
  77    /**
  78     * Query an integer-valued capability/parameter/limit
  79     * \param param  one of PIPE_CAP_x
  80     */
  81    int (*get_param)( struct pipe_screen *, enum pipe_cap param );
  82
  83    /**
  84     * Query a float-valued capability/parameter/limit
  85     * \param param  one of PIPE_CAP_x
  86     */
  87    float (*get_paramf)( struct pipe_screen *, enum pipe_cap param );
  88
  89    struct pipe_context * (*context_create)( struct pipe_screen *,
  90                                             void *priv );
  91
  92    /**
  93     * Check if the given pipe_format is supported as a texture or
  94     * drawing surface.
  95     * \param bindings  bitmask of PIPE_BIND_*
  96     * \param geom_flags  bitmask of PIPE_TEXTURE_GEOM_*
  97     */
  98    boolean (*is_format_supported)( struct pipe_screen *,
  99                                    enum pipe_format format,
 100                                    enum pipe_texture_target target,
 101                                    unsigned bindings,
 102                                    unsigned geom_flags );
 103
 104    /**
 105     * Create a new texture object, using the given template info.
 106     */
 107    struct pipe_resource * (*resource_create)(struct pipe_screen *,
 108                                              const struct pipe_resource *templat);
 109
 110    /**
 111     * Create a texture from a winsys_handle. The handle is often created in
 112     * another process by first creating a pipe texture and then calling
 113     * texture_get_handle.
 114     */
 115    struct pipe_resource * (*resource_from_handle)(struct pipe_screen *,
 116                                                   const struct pipe_resource *templat,
 117                                                   struct winsys_handle *handle);
 118
 119    /**
 120     * Get a winsys_handle from a texture. Some platforms/winsys requires
 121     * that the texture is created with a special usage flag like
 122     * DISPLAYTARGET or PRIMARY.
 123     */
 124    boolean (*resource_get_handle)(struct pipe_screen *,
 125                                   struct pipe_resource *tex,
 126                                   struct winsys_handle *handle);
 127
 128
 129    void (*resource_destroy)(struct pipe_screen *,
 130                             struct pipe_resource *pt);
 131
 132    /** Get a 2D surface which is a "view" into a texture
 133     * \param usage  bitmaks of PIPE_BIND_* flags
 134     */
 135    struct pipe_surface *(*get_tex_surface)(struct pipe_screen *,
 136                                            struct pipe_resource *resource,
 137                                            unsigned face, unsigned level,
 138                                            unsigned zslice,
 139                                            unsigned usage );
 140
 141    void (*tex_surface_destroy)(struct pipe_surface *);
 142
 143
 144
 145    /**
 146     * Create a buffer that wraps user-space data.
 147     *
 148     * Effectively this schedules a delayed call to buffer_create
 149     * followed by an upload of the data at *some point in the future*,
 150     * or perhaps never.  Basically the allocate/upload is delayed
 151     * until the buffer is actually passed to hardware.
 152     *
 153     * The intention is to provide a quick way to turn regular data
 154     * into a buffer, and secondly to avoid a copy operation if that
 155     * data subsequently turns out to be only accessed by the CPU.
 156     *
 157     * Common example is OpenGL vertex buffers that are subsequently
 158     * processed either by software TNL in the driver or by passing to
 159     * hardware.
 160     *
 161     * XXX: What happens if the delayed call to buffer_create() fails?
 162     *
 163     * Note that ptr may be accessed at any time upto the time when the
 164     * buffer is destroyed, so the data must not be freed before then.
 165     */
 166    struct pipe_resource *(*user_buffer_create)(struct pipe_screen *screen,
 167                                                void *ptr,
 168                                                unsigned bytes,
 169                                                unsigned bind_flags);
 170
 171    /**
 172     * Do any special operations to ensure frontbuffer contents are
 173     * displayed, eg copy fake frontbuffer.
 174     * \param winsys_drawable_handle  an opaque handle that the calling context
 175     *                                gets out-of-band
 176     */
 177    void (*flush_frontbuffer)( struct pipe_screen *screen,
 178                               struct pipe_surface *surf,
 179                               void *winsys_drawable_handle );
 180
 181
 182
 183    /** Set ptr = fence, with reference counting */
 184    void (*fence_reference)( struct pipe_screen *screen,
 185                             struct pipe_fence_handle **ptr,
 186                             struct pipe_fence_handle *fence );
 187
 188    /**
 189     * Checks whether the fence has been signalled.
 190     * \param flags  driver-specific meaning
 191     * \return zero on success.
 192     */
 193    int (*fence_signalled)( struct pipe_screen *screen,
 194                            struct pipe_fence_handle *fence,
 195                            unsigned flags );
 196
 197    /**
 198     * Wait for the fence to finish.
 199     * \param flags  driver-specific meaning
 200     * \return zero on success.
 201     */
 202    int (*fence_finish)( struct pipe_screen *screen,
 203                         struct pipe_fence_handle *fence,
 204                         unsigned flags );
 205
 206 };
 207
 208
 209 #ifdef __cplusplus
 210 }
 211 #endif
 212
 213 #endif /* P_SCREEN_H */