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 #include "pipe/p_video_enums.h"
  45
  46
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52
  53 /** Opaque type */
  54 struct winsys_handle;
  55 /** Opaque type */
  56 struct pipe_fence_handle;
  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    void (*destroy)( struct pipe_screen * );
  69
  70
  71    const char *(*get_name)( struct pipe_screen * );
  72
  73    const char *(*get_vendor)( struct pipe_screen * );
  74
  75    /**
  76     * Query an integer-valued capability/parameter/limit
  77     * \param param  one of PIPE_CAP_x
  78     */
  79    int (*get_param)( struct pipe_screen *, enum pipe_cap param );
  80
  81    /**
  82     * Query a float-valued capability/parameter/limit
  83     * \param param  one of PIPE_CAP_x
  84     */
  85    float (*get_paramf)( struct pipe_screen *, enum pipe_capf param );
  86
  87    /**
  88     * Query a per-shader-stage integer-valued capability/parameter/limit
  89     * \param param  one of PIPE_CAP_x
  90     */
  91    int (*get_shader_param)( struct pipe_screen *, unsigned shader, enum pipe_shader_cap param );
  92
  93    /**
  94     * Query an integer-valued capability/parameter/limit for a codec/profile
  95     * \param param  one of PIPE_VIDEO_CAP_x
  96     */
  97    int (*get_video_param)( struct pipe_screen *,
  98                            enum pipe_video_profile profile,
  99                            enum pipe_video_cap param );
 100
 101    struct pipe_context * (*context_create)( struct pipe_screen *,
 102                                             void *priv );
 103
 104    /**
 105     * Check if the given pipe_format is supported as a texture or
 106     * drawing surface.
 107     * \param bindings  bitmask of PIPE_BIND_*
 108     */
 109    boolean (*is_format_supported)( struct pipe_screen *,
 110                                    enum pipe_format format,
 111                                    enum pipe_texture_target target,
 112                                    unsigned sample_count,
 113                                    unsigned bindings );
 114
 115    /**
 116     * Check if the given pipe_format is supported as output for this codec/profile.
 117     * \param profile  profile to check, may also be PIPE_VIDEO_PROFILE_UNKNOWN
 118     */
 119    boolean (*is_video_format_supported)( struct pipe_screen *,
 120                                          enum pipe_format format,
 121                                          enum pipe_video_profile profile );
 122
 123    /**
 124     * Create a new texture object, using the given template info.
 125     */
 126    struct pipe_resource * (*resource_create)(struct pipe_screen *,
 127                                              const struct pipe_resource *templat);
 128
 129    /**
 130     * Create a texture from a winsys_handle. The handle is often created in
 131     * another process by first creating a pipe texture and then calling
 132     * resource_get_handle.
 133     */
 134    struct pipe_resource * (*resource_from_handle)(struct pipe_screen *,
 135                                                   const struct pipe_resource *templat,
 136                                                   struct winsys_handle *handle);
 137
 138    /**
 139     * Get a winsys_handle from a texture. Some platforms/winsys requires
 140     * that the texture is created with a special usage flag like
 141     * DISPLAYTARGET or PRIMARY.
 142     */
 143    boolean (*resource_get_handle)(struct pipe_screen *,
 144                                   struct pipe_resource *tex,
 145                                   struct winsys_handle *handle);
 146
 147
 148    void (*resource_destroy)(struct pipe_screen *,
 149                             struct pipe_resource *pt);
 150
 151
 152    /**
 153     * Create a buffer that wraps user-space data.
 154     *
 155     * Effectively this schedules a delayed call to buffer_create
 156     * followed by an upload of the data at *some point in the future*,
 157     * or perhaps never.  Basically the allocate/upload is delayed
 158     * until the buffer is actually passed to hardware.
 159     *
 160     * The intention is to provide a quick way to turn regular data
 161     * into a buffer, and secondly to avoid a copy operation if that
 162     * data subsequently turns out to be only accessed by the CPU.
 163     *
 164     * Common example is OpenGL vertex buffers that are subsequently
 165     * processed either by software TNL in the driver or by passing to
 166     * hardware.
 167     *
 168     * XXX: What happens if the delayed call to buffer_create() fails?
 169     *
 170     * Note that ptr may be accessed at any time upto the time when the
 171     * buffer is destroyed, so the data must not be freed before then.
 172     */
 173    struct pipe_resource *(*user_buffer_create)(struct pipe_screen *screen,
 174                                                void *ptr,
 175                                                unsigned bytes,
 176                                                unsigned bind_flags);
 177
 178    /**
 179     * Do any special operations to ensure frontbuffer contents are
 180     * displayed, eg copy fake frontbuffer.
 181     * \param winsys_drawable_handle  an opaque handle that the calling context
 182     *                                gets out-of-band
 183     */
 184    void (*flush_frontbuffer)( struct pipe_screen *screen,
 185                               struct pipe_resource *resource,
 186                               unsigned level, unsigned layer,
 187                               void *winsys_drawable_handle );
 188
 189
 190
 191    /** Set ptr = fence, with reference counting */
 192    void (*fence_reference)( struct pipe_screen *screen,
 193                             struct pipe_fence_handle **ptr,
 194                             struct pipe_fence_handle *fence );
 195
 196    /**
 197     * Checks whether the fence has been signalled.
 198     */
 199    boolean (*fence_signalled)( struct pipe_screen *screen,
 200                                struct pipe_fence_handle *fence );
 201
 202    /**
 203     * Wait for the fence to finish.
 204     * \param timeout  in nanoseconds
 205     */
 206    boolean (*fence_finish)( struct pipe_screen *screen,
 207                             struct pipe_fence_handle *fence,
 208                             uint64_t timeout );
 209
 210 };
 211
 212
 213 #ifdef __cplusplus
 214 }
 215 #endif
 216
 217 #endif /* P_SCREEN_H */