src/gallium/include/state_tracker/st_api.h

   1 /**********************************************************
   2  * Copyright 2010 VMware, Inc.  All rights reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person
   5  * obtaining a copy of this software and associated documentation
   6  * files (the "Software"), to deal in the Software without
   7  * restriction, including without limitation the rights to use, copy,
   8  * modify, merge, publish, distribute, sublicense, and/or sell copies
   9  * of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be
  13  * included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  19  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  20  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  *
  24  **********************************************************/
  25
  26
  27 #ifndef _ST_API_H_
  28 #define _ST_API_H_
  29
  30 #include "pipe/p_compiler.h"
  31 #include "pipe/p_format.h"
  32
  33 /**
  34  * \file API for communication between state trackers and state tracker
  35  * managers.
  36  *
  37  * While both are state tackers, we use the term state tracker for rendering
  38  * APIs such as OpenGL or OpenVG, and state tracker manager for window system
  39  * APIs such as EGL or GLX in this file.
  40  *
  41  * This file defines an API to be implemented by both state trackers and state
  42  * tracker managers.
  43  */
  44
  45 /**
  46  * The supported rendering API of a state tracker.
  47  */
  48 enum st_api_type {
  49    ST_API_OPENGL,
  50    ST_API_OPENVG,
  51
  52    ST_API_COUNT
  53 };
  54
  55 /**
  56  * The profile of a context.
  57  */
  58 enum st_profile_type
  59 {
  60    ST_PROFILE_DEFAULT,                  /**< OpenGL compatibility profile */
  61    ST_PROFILE_OPENGL_CORE,              /**< OpenGL 3.2+ core profile */
  62    ST_PROFILE_OPENGL_ES1,               /**< OpenGL ES 1.x */
  63    ST_PROFILE_OPENGL_ES2                /**< OpenGL ES 2.0 */
  64 };
  65
  66 /* for profile_mask in st_api */
  67 #define ST_PROFILE_DEFAULT_MASK      (1 << ST_PROFILE_DEFAULT)
  68 #define ST_PROFILE_OPENGL_CORE_MASK  (1 << ST_PROFILE_OPENGL_CORE)
  69 #define ST_PROFILE_OPENGL_ES1_MASK   (1 << ST_PROFILE_OPENGL_ES1)
  70 #define ST_PROFILE_OPENGL_ES2_MASK   (1 << ST_PROFILE_OPENGL_ES2)
  71
  72 /**
  73  * New context flags for GL 3.0 and beyond.
  74  *
  75  * Profile information (core vs. compatibilty for OpenGL 3.2+) is communicated
  76  * through the \c st_profile_type, not through flags.
  77  */
  78 #define ST_CONTEXT_FLAG_DEBUG               (1 << 0)
  79 #define ST_CONTEXT_FLAG_FORWARD_COMPATIBLE  (1 << 1)
  80 #define ST_CONTEXT_FLAG_ROBUST_ACCESS       (1 << 2)
  81
  82 /**
  83  * Used in st_context_iface->teximage.
  84  */
  85 enum st_texture_type {
  86    ST_TEXTURE_1D,
  87    ST_TEXTURE_2D,
  88    ST_TEXTURE_3D,
  89    ST_TEXTURE_RECT
  90 };
  91
  92 /**
  93  * Available attachments of framebuffer.
  94  */
  95 enum st_attachment_type {
  96    ST_ATTACHMENT_FRONT_LEFT,
  97    ST_ATTACHMENT_BACK_LEFT,
  98    ST_ATTACHMENT_FRONT_RIGHT,
  99    ST_ATTACHMENT_BACK_RIGHT,
 100    ST_ATTACHMENT_DEPTH_STENCIL,
 101    ST_ATTACHMENT_ACCUM,
 102    ST_ATTACHMENT_SAMPLE,
 103
 104    ST_ATTACHMENT_COUNT,
 105    ST_ATTACHMENT_INVALID = -1
 106 };
 107
 108 /* for buffer_mask in st_visual */
 109 #define ST_ATTACHMENT_FRONT_LEFT_MASK     (1 << ST_ATTACHMENT_FRONT_LEFT)
 110 #define ST_ATTACHMENT_BACK_LEFT_MASK      (1 << ST_ATTACHMENT_BACK_LEFT)
 111 #define ST_ATTACHMENT_FRONT_RIGHT_MASK    (1 << ST_ATTACHMENT_FRONT_RIGHT)
 112 #define ST_ATTACHMENT_BACK_RIGHT_MASK     (1 << ST_ATTACHMENT_BACK_RIGHT)
 113 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK  (1 << ST_ATTACHMENT_DEPTH_STENCIL)
 114 #define ST_ATTACHMENT_ACCUM_MASK          (1 << ST_ATTACHMENT_ACCUM)
 115 #define ST_ATTACHMENT_SAMPLE_MASK         (1 << ST_ATTACHMENT_SAMPLE)
 116
 117 /**
 118  * Enumerations of state tracker context resources.
 119  */
 120 enum st_context_resource_type {
 121    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_2D,
 122    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_3D,
 123    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_X,
 124    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_X,
 125    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Y,
 126    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Y,
 127    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Z,
 128    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
 129    ST_CONTEXT_RESOURCE_OPENGL_RENDERBUFFER,
 130    ST_CONTEXT_RESOURCE_OPENVG_PARENT_IMAGE
 131 };
 132
 133 /**
 134  * Flush flags.
 135  */
 136 #define ST_FLUSH_FRONT                    (1 << 0)
 137
 138 /**
 139  * Value to st_manager->get_param function.
 140  */
 141 enum st_manager_param {
 142    /**
 143     * The dri state tracker on old libGL's doesn't do the right thing
 144     * with regards to invalidating the framebuffers.
 145     *
 146     * For the mesa state tracker that means that it needs to invalidate
 147     * the framebuffer in glViewport itself.
 148     */
 149    ST_MANAGER_BROKEN_INVALIDATE
 150 };
 151
 152 /**
 153  * The return type of st_api->get_proc_address.
 154  */
 155 typedef void (*st_proc_t)(void);
 156
 157 struct pipe_context;
 158 struct pipe_resource;
 159 struct pipe_fence_handle;
 160
 161 /**
 162  * Used in st_context_iface->get_resource_for_egl_image.
 163  */
 164 struct st_context_resource
 165 {
 166    /* these fields are filled by the caller */
 167    enum st_context_resource_type type;
 168    void *resource;
 169
 170    /* this is owned by the caller */
 171    struct pipe_resource *texture;
 172 };
 173
 174 /**
 175  * Used in st_manager_iface->get_egl_image.
 176  */
 177 struct st_egl_image
 178 {
 179    /* this is owned by the caller */
 180    struct pipe_resource *texture;
 181
 182    unsigned level;
 183    unsigned layer;
 184 };
 185
 186 /**
 187  * Represent the visual of a framebuffer.
 188  */
 189 struct st_visual
 190 {
 191    /**
 192     * Available buffers.  Tested with ST_FRAMEBUFFER_*_MASK.
 193     */
 194    unsigned buffer_mask;
 195
 196    /**
 197     * Buffer formats.  The formats are always set even when the buffer is
 198     * not available.
 199     */
 200    enum pipe_format color_format;
 201    enum pipe_format depth_stencil_format;
 202    enum pipe_format accum_format;
 203    int samples;
 204
 205    /**
 206     * Desired render buffer.
 207     */
 208    enum st_attachment_type render_buffer;
 209 };
 210
 211 /**
 212  * Represent the attributes of a context.
 213  */
 214 struct st_context_attribs
 215 {
 216    /**
 217     * The profile and minimal version to support.
 218     *
 219     * The valid profiles and versions are rendering API dependent.  The latest
 220     * version satisfying the request should be returned, unless the
 221     * ST_CONTEXT_FLAG_FORWARD_COMPATIBLE bit is set.
 222     */
 223    enum st_profile_type profile;
 224    int major, minor;
 225
 226    /** Mask of ST_CONTEXT_FLAG_x bits */
 227    unsigned flags;
 228
 229    /**
 230     * The visual of the framebuffers the context will be bound to.
 231     */
 232    struct st_visual visual;
 233 };
 234
 235 /**
 236  * Represent a windowing system drawable.
 237  *
 238  * The framebuffer is implemented by the state tracker manager and
 239  * used by the state trackers.
 240  *
 241  * Instead of the winsys pokeing into the API context to figure
 242  * out what buffers that might be needed in the future by the API
 243  * context, it calls into the framebuffer to get the textures.
 244  *
 245  * This structure along with the notify_invalid_framebuffer
 246  * allows framebuffers to be shared between different threads
 247  * but at the same make the API context free from thread
 248  * syncronisation primitves, with the exception of a small
 249  * atomic flag used for notification of framebuffer dirty status.
 250  *
 251  * The thread syncronisation is put inside the framebuffer
 252  * and only called once the framebuffer has become dirty.
 253  */
 254 struct st_framebuffer_iface
 255 {
 256    /**
 257     * Atomic stamp which changes when framebuffers need to be updated.
 258     */
 259
 260    int32_t stamp;
 261
 262    /**
 263     * Available for the state tracker manager to use.
 264     */
 265    void *st_manager_private;
 266
 267    /**
 268     * The visual of a framebuffer.
 269     */
 270    const struct st_visual *visual;
 271
 272    /**
 273     * Flush the front buffer.
 274     *
 275     * On some window systems, changes to the front buffers are not immediately
 276     * visible.  They need to be flushed.
 277     *
 278     * @att is one of the front buffer attachments.
 279     */
 280    boolean (*flush_front)(struct st_framebuffer_iface *stfbi,
 281                           enum st_attachment_type statt);
 282
 283    /**
 284     * The state tracker asks for the textures it needs.
 285     *
 286     * It should try to only ask for attachments that it currently renders
 287     * to, thus allowing the winsys to delay the allocation of textures not
 288     * needed. For example front buffer attachments are not needed if you
 289     * only do back buffer rendering.
 290     *
 291     * The implementor of this function needs to also ensure
 292     * thread safty as this call might be done from multiple threads.
 293     *
 294     * The returned textures are owned by the caller.  They should be
 295     * unreferenced when no longer used.  If this function is called multiple
 296     * times with different sets of attachments, those buffers not included in
 297     * the last call might be destroyed.  This behavior might change in the
 298     * future.
 299     */
 300    boolean (*validate)(struct st_framebuffer_iface *stfbi,
 301                        const enum st_attachment_type *statts,
 302                        unsigned count,
 303                        struct pipe_resource **out);
 304 };
 305
 306 /**
 307  * Represent a rendering context.
 308  *
 309  * This entity is created from st_api and used by the state tracker manager.
 310  */
 311 struct st_context_iface
 312 {
 313    /**
 314     * Available for the state tracker and the manager to use.
 315     */
 316    void *st_context_private;
 317    void *st_manager_private;
 318
 319    /**
 320     * Destroy the context.
 321     */
 322    void (*destroy)(struct st_context_iface *stctxi);
 323
 324    /**
 325     * Flush all drawing from context to the pipe also flushes the pipe.
 326     */
 327    void (*flush)(struct st_context_iface *stctxi, unsigned flags,
 328                  struct pipe_fence_handle **fence);
 329
 330    /**
 331     * Replace the texture image of a texture object at the specified level.
 332     *
 333     * This function is optional.
 334     */
 335    boolean (*teximage)(struct st_context_iface *stctxi, enum st_texture_type target,
 336                        int level, enum pipe_format internal_format,
 337                        struct pipe_resource *tex, boolean mipmap);
 338
 339    /**
 340     * Used to implement glXCopyContext.
 341     */
 342    void (*copy)(struct st_context_iface *stctxi,
 343                 struct st_context_iface *stsrci, unsigned mask);
 344
 345    /**
 346     * Used to implement wglShareLists.
 347     */
 348    boolean (*share)(struct st_context_iface *stctxi,
 349                     struct st_context_iface *stsrci);
 350
 351    /**
 352     * Look up and return the info of a resource for EGLImage.
 353     *
 354     * This function is optional.
 355     */
 356    boolean (*get_resource_for_egl_image)(struct st_context_iface *stctxi,
 357                                          struct st_context_resource *stres);
 358 };
 359
 360
 361 /**
 362  * Represent a state tracker manager.
 363  *
 364  * This interface is implemented by the state tracker manager.  It corresponds
 365  * to a "display" in the window system.
 366  */
 367 struct st_manager
 368 {
 369    struct pipe_screen *screen;
 370
 371    /**
 372     * Look up and return the info of an EGLImage.
 373     *
 374     * This is used to implement for example EGLImageTargetTexture2DOES.
 375     * The GLeglImageOES agrument of that call is passed directly to this
 376     * function call and the information needed to access this is returned
 377     * in the given struct out.
 378     *
 379     * @smapi: manager owning the caller context
 380     * @stctx: caller context
 381     * @egl_image: EGLImage that caller recived
 382     * @out: return struct filled out with access information.
 383     *
 384     * This function is optional.
 385     */
 386    boolean (*get_egl_image)(struct st_manager *smapi,
 387                             void *egl_image,
 388                             struct st_egl_image *out);
 389
 390    /**
 391     * Query an manager param.
 392     */
 393    int (*get_param)(struct st_manager *smapi,
 394                     enum st_manager_param param);
 395 };
 396
 397 /**
 398  * Represent a rendering API such as OpenGL or OpenVG.
 399  *
 400  * Implemented by the state tracker and used by the state tracker manager.
 401  */
 402 struct st_api
 403 {
 404    /**
 405     * The name of the rendering API.  This is informative.
 406     */
 407    const char *name;
 408
 409    /**
 410     * The supported rendering API.
 411     */
 412    enum st_api_type api;
 413
 414    /**
 415     * The supported profiles.  Tested with ST_PROFILE_*_MASK.
 416     */
 417    unsigned profile_mask;
 418
 419    /**
 420     * Destroy the API.
 421     */
 422    void (*destroy)(struct st_api *stapi);
 423
 424    /**
 425     * Return an API entry point.
 426     *
 427     * For GL this is the same as _glapi_get_proc_address.
 428     */
 429    st_proc_t (*get_proc_address)(struct st_api *stapi, const char *procname);
 430
 431    /**
 432     * Create a rendering context.
 433     */
 434    struct st_context_iface *(*create_context)(struct st_api *stapi,
 435                                               struct st_manager *smapi,
 436                                               const struct st_context_attribs *attribs,
 437                                               struct st_context_iface *stsharei);
 438
 439    /**
 440     * Bind the context to the calling thread with draw and read as drawables.
 441     *
 442     * The framebuffers might be NULL, or might have different visuals than the
 443     * context does.
 444     */
 445    boolean (*make_current)(struct st_api *stapi,
 446                            struct st_context_iface *stctxi,
 447                            struct st_framebuffer_iface *stdrawi,
 448                            struct st_framebuffer_iface *streadi);
 449
 450    /**
 451     * Get the currently bound context in the calling thread.
 452     */
 453    struct st_context_iface *(*get_current)(struct st_api *stapi);
 454 };
 455
 456 /**
 457  * Return true if the visual has the specified buffers.
 458  */
 459 static INLINE boolean
 460 st_visual_have_buffers(const struct st_visual *visual, unsigned mask)
 461 {
 462    return ((visual->buffer_mask & mask) == mask);
 463 }
 464
 465 #endif /* _ST_API_H_ */