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  * Optional API/state tracker features.
  74  */
  75 enum st_api_feature
  76 {
  77    ST_API_FEATURE_MS_VISUALS  /**< support for multisample visuals */
  78 };
  79
  80 /* for feature_mask in st_api */
  81 #define ST_API_FEATURE_MS_VISUALS_MASK (1 << ST_API_FEATURE_MS_VISUALS)
  82
  83 /**
  84  * New context flags for GL 3.0 and beyond.
  85  *
  86  * Profile information (core vs. compatibilty for OpenGL 3.2+) is communicated
  87  * through the \c st_profile_type, not through flags.
  88  */
  89 #define ST_CONTEXT_FLAG_DEBUG               (1 << 0)
  90 #define ST_CONTEXT_FLAG_FORWARD_COMPATIBLE  (1 << 1)
  91 #define ST_CONTEXT_FLAG_ROBUST_ACCESS       (1 << 2)
  92
  93 /**
  94  * Reasons that context creation might fail.
  95  */
  96 enum st_context_error {
  97    ST_CONTEXT_SUCCESS = 0,
  98    ST_CONTEXT_ERROR_NO_MEMORY,
  99    ST_CONTEXT_ERROR_BAD_API,
 100    ST_CONTEXT_ERROR_BAD_VERSION,
 101    ST_CONTEXT_ERROR_BAD_FLAG,
 102    ST_CONTEXT_ERROR_UNKNOWN_ATTRIBUTE,
 103    ST_CONTEXT_ERROR_UNKNOWN_FLAG
 104 };
 105
 106 /**
 107  * Used in st_context_iface->teximage.
 108  */
 109 enum st_texture_type {
 110    ST_TEXTURE_1D,
 111    ST_TEXTURE_2D,
 112    ST_TEXTURE_3D,
 113    ST_TEXTURE_RECT
 114 };
 115
 116 /**
 117  * Available attachments of framebuffer.
 118  */
 119 enum st_attachment_type {
 120    ST_ATTACHMENT_FRONT_LEFT,
 121    ST_ATTACHMENT_BACK_LEFT,
 122    ST_ATTACHMENT_FRONT_RIGHT,
 123    ST_ATTACHMENT_BACK_RIGHT,
 124    ST_ATTACHMENT_DEPTH_STENCIL,
 125    ST_ATTACHMENT_ACCUM,
 126    ST_ATTACHMENT_SAMPLE,
 127
 128    ST_ATTACHMENT_COUNT,
 129    ST_ATTACHMENT_INVALID = -1
 130 };
 131
 132 /* for buffer_mask in st_visual */
 133 #define ST_ATTACHMENT_FRONT_LEFT_MASK     (1 << ST_ATTACHMENT_FRONT_LEFT)
 134 #define ST_ATTACHMENT_BACK_LEFT_MASK      (1 << ST_ATTACHMENT_BACK_LEFT)
 135 #define ST_ATTACHMENT_FRONT_RIGHT_MASK    (1 << ST_ATTACHMENT_FRONT_RIGHT)
 136 #define ST_ATTACHMENT_BACK_RIGHT_MASK     (1 << ST_ATTACHMENT_BACK_RIGHT)
 137 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK  (1 << ST_ATTACHMENT_DEPTH_STENCIL)
 138 #define ST_ATTACHMENT_ACCUM_MASK          (1 << ST_ATTACHMENT_ACCUM)
 139 #define ST_ATTACHMENT_SAMPLE_MASK         (1 << ST_ATTACHMENT_SAMPLE)
 140
 141 /**
 142  * Enumerations of state tracker context resources.
 143  */
 144 enum st_context_resource_type {
 145    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_2D,
 146    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_3D,
 147    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_X,
 148    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_X,
 149    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Y,
 150    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Y,
 151    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Z,
 152    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
 153    ST_CONTEXT_RESOURCE_OPENGL_RENDERBUFFER,
 154    ST_CONTEXT_RESOURCE_OPENVG_PARENT_IMAGE
 155 };
 156
 157 /**
 158  * Flush flags.
 159  */
 160 #define ST_FLUSH_FRONT                    (1 << 0)
 161
 162 /**
 163  * Value to st_manager->get_param function.
 164  */
 165 enum st_manager_param {
 166    /**
 167     * The dri state tracker on old libGL's doesn't do the right thing
 168     * with regards to invalidating the framebuffers.
 169     *
 170     * For the mesa state tracker that means that it needs to invalidate
 171     * the framebuffer in glViewport itself.
 172     */
 173    ST_MANAGER_BROKEN_INVALIDATE
 174 };
 175
 176 /**
 177  * The return type of st_api->get_proc_address.
 178  */
 179 typedef void (*st_proc_t)(void);
 180
 181 struct pipe_context;
 182 struct pipe_resource;
 183 struct pipe_fence_handle;
 184
 185 /**
 186  * Used in st_context_iface->get_resource_for_egl_image.
 187  */
 188 struct st_context_resource
 189 {
 190    /* these fields are filled in by the caller */
 191    enum st_context_resource_type type;
 192    void *resource;
 193
 194    /* this is owned by the caller */
 195    struct pipe_resource *texture;
 196 };
 197
 198 /**
 199  * Used in st_manager_iface->get_egl_image.
 200  */
 201 struct st_egl_image
 202 {
 203    /* this is owned by the caller */
 204    struct pipe_resource *texture;
 205
 206    unsigned level;
 207    unsigned layer;
 208 };
 209
 210 /**
 211  * Represent the visual of a framebuffer.
 212  */
 213 struct st_visual
 214 {
 215    /**
 216     * Available buffers.  Tested with ST_FRAMEBUFFER_*_MASK.
 217     */
 218    unsigned buffer_mask;
 219
 220    /**
 221     * Buffer formats.  The formats are always set even when the buffer is
 222     * not available.
 223     */
 224    enum pipe_format color_format;
 225    enum pipe_format depth_stencil_format;
 226    enum pipe_format accum_format;
 227    int samples;
 228
 229    /**
 230     * Desired render buffer.
 231     */
 232    enum st_attachment_type render_buffer;
 233 };
 234
 235 /**
 236  * Represent the attributes of a context.
 237  */
 238 struct st_context_attribs
 239 {
 240    /**
 241     * The profile and minimal version to support.
 242     *
 243     * The valid profiles and versions are rendering API dependent.  The latest
 244     * version satisfying the request should be returned, unless the
 245     * ST_CONTEXT_FLAG_FORWARD_COMPATIBLE bit is set.
 246     */
 247    enum st_profile_type profile;
 248    int major, minor;
 249
 250    /** Mask of ST_CONTEXT_FLAG_x bits */
 251    unsigned flags;
 252
 253    /**
 254     * The visual of the framebuffers the context will be bound to.
 255     */
 256    struct st_visual visual;
 257 };
 258
 259 /**
 260  * Represent a windowing system drawable.
 261  *
 262  * The framebuffer is implemented by the state tracker manager and
 263  * used by the state trackers.
 264  *
 265  * Instead of the winsys poking into the API context to figure
 266  * out what buffers that might be needed in the future by the API
 267  * context, it calls into the framebuffer to get the textures.
 268  *
 269  * This structure along with the notify_invalid_framebuffer
 270  * allows framebuffers to be shared between different threads
 271  * but at the same make the API context free from thread
 272  * synchronization primitves, with the exception of a small
 273  * atomic flag used for notification of framebuffer dirty status.
 274  *
 275  * The thread synchronization is put inside the framebuffer
 276  * and only called once the framebuffer has become dirty.
 277  */
 278 struct st_framebuffer_iface
 279 {
 280    /**
 281     * Atomic stamp which changes when framebuffers need to be updated.
 282     */
 283    int32_t stamp;
 284
 285    /**
 286     * Available for the state tracker manager to use.
 287     */
 288    void *st_manager_private;
 289
 290    /**
 291     * The visual of a framebuffer.
 292     */
 293    const struct st_visual *visual;
 294
 295    /**
 296     * Flush the front buffer.
 297     *
 298     * On some window systems, changes to the front buffers are not immediately
 299     * visible.  They need to be flushed.
 300     *
 301     * @att is one of the front buffer attachments.
 302     */
 303    boolean (*flush_front)(struct st_framebuffer_iface *stfbi,
 304                           enum st_attachment_type statt);
 305
 306    /**
 307     * The state tracker asks for the textures it needs.
 308     *
 309     * It should try to only ask for attachments that it currently renders
 310     * to, thus allowing the winsys to delay the allocation of textures not
 311     * needed. For example front buffer attachments are not needed if you
 312     * only do back buffer rendering.
 313     *
 314     * The implementor of this function needs to also ensure
 315     * thread safty as this call might be done from multiple threads.
 316     *
 317     * The returned textures are owned by the caller.  They should be
 318     * unreferenced when no longer used.  If this function is called multiple
 319     * times with different sets of attachments, those buffers not included in
 320     * the last call might be destroyed.  This behavior might change in the
 321     * future.
 322     */
 323    boolean (*validate)(struct st_framebuffer_iface *stfbi,
 324                        const enum st_attachment_type *statts,
 325                        unsigned count,
 326                        struct pipe_resource **out);
 327 };
 328
 329 /**
 330  * Represent a rendering context.
 331  *
 332  * This entity is created from st_api and used by the state tracker manager.
 333  */
 334 struct st_context_iface
 335 {
 336    /**
 337     * Available for the state tracker and the manager to use.
 338     */
 339    void *st_context_private;
 340    void *st_manager_private;
 341
 342    /**
 343     * Destroy the context.
 344     */
 345    void (*destroy)(struct st_context_iface *stctxi);
 346
 347    /**
 348     * Flush all drawing from context to the pipe also flushes the pipe.
 349     */
 350    void (*flush)(struct st_context_iface *stctxi, unsigned flags,
 351                  struct pipe_fence_handle **fence);
 352
 353    /**
 354     * Replace the texture image of a texture object at the specified level.
 355     *
 356     * This function is optional.
 357     */
 358    boolean (*teximage)(struct st_context_iface *stctxi,
 359                        enum st_texture_type target,
 360                        int level, enum pipe_format internal_format,
 361                        struct pipe_resource *tex, boolean mipmap);
 362
 363    /**
 364     * Used to implement glXCopyContext.
 365     */
 366    void (*copy)(struct st_context_iface *stctxi,
 367                 struct st_context_iface *stsrci, unsigned mask);
 368
 369    /**
 370     * Used to implement wglShareLists.
 371     */
 372    boolean (*share)(struct st_context_iface *stctxi,
 373                     struct st_context_iface *stsrci);
 374
 375    /**
 376     * Look up and return the info of a resource for EGLImage.
 377     *
 378     * This function is optional.
 379     */
 380    boolean (*get_resource_for_egl_image)(struct st_context_iface *stctxi,
 381                                          struct st_context_resource *stres);
 382 };
 383
 384
 385 /**
 386  * Represent a state tracker manager.
 387  *
 388  * This interface is implemented by the state tracker manager.  It corresponds
 389  * to a "display" in the window system.
 390  */
 391 struct st_manager
 392 {
 393    struct pipe_screen *screen;
 394
 395    /**
 396     * Look up and return the info of an EGLImage.
 397     *
 398     * This is used to implement for example EGLImageTargetTexture2DOES.
 399     * The GLeglImageOES agrument of that call is passed directly to this
 400     * function call and the information needed to access this is returned
 401     * in the given struct out.
 402     *
 403     * @smapi: manager owning the caller context
 404     * @stctx: caller context
 405     * @egl_image: EGLImage that caller recived
 406     * @out: return struct filled out with access information.
 407     *
 408     * This function is optional.
 409     */
 410    boolean (*get_egl_image)(struct st_manager *smapi,
 411                             void *egl_image,
 412                             struct st_egl_image *out);
 413
 414    /**
 415     * Query an manager param.
 416     */
 417    int (*get_param)(struct st_manager *smapi,
 418                     enum st_manager_param param);
 419 };
 420
 421 /**
 422  * Represent a rendering API such as OpenGL or OpenVG.
 423  *
 424  * Implemented by the state tracker and used by the state tracker manager.
 425  */
 426 struct st_api
 427 {
 428    /**
 429     * The name of the rendering API.  This is informative.
 430     */
 431    const char *name;
 432
 433    /**
 434     * The supported rendering API.
 435     */
 436    enum st_api_type api;
 437
 438    /**
 439     * The supported profiles.  Tested with ST_PROFILE_*_MASK.
 440     */
 441    unsigned profile_mask;
 442
 443    /**
 444     * The supported optional features.  Tested with ST_FEATURE_*_MASK.
 445     */
 446    unsigned feature_mask;
 447
 448    /**
 449     * Destroy the API.
 450     */
 451    void (*destroy)(struct st_api *stapi);
 452
 453    /**
 454     * Return an API entry point.
 455     *
 456     * For GL this is the same as _glapi_get_proc_address.
 457     */
 458    st_proc_t (*get_proc_address)(struct st_api *stapi, const char *procname);
 459
 460    /**
 461     * Create a rendering context.
 462     */
 463    struct st_context_iface *(*create_context)(struct st_api *stapi,
 464                                               struct st_manager *smapi,
 465                                               const struct st_context_attribs *attribs,
 466                                               enum st_context_error *error,
 467                                               struct st_context_iface *stsharei);
 468
 469    /**
 470     * Bind the context to the calling thread with draw and read as drawables.
 471     *
 472     * The framebuffers might be NULL, or might have different visuals than the
 473     * context does.
 474     */
 475    boolean (*make_current)(struct st_api *stapi,
 476                            struct st_context_iface *stctxi,
 477                            struct st_framebuffer_iface *stdrawi,
 478                            struct st_framebuffer_iface *streadi);
 479
 480    /**
 481     * Get the currently bound context in the calling thread.
 482     */
 483    struct st_context_iface *(*get_current)(struct st_api *stapi);
 484 };
 485
 486 /**
 487  * Return true if the visual has the specified buffers.
 488  */
 489 static INLINE boolean
 490 st_visual_have_buffers(const struct st_visual *visual, unsigned mask)
 491 {
 492    return ((visual->buffer_mask & mask) == mask);
 493 }
 494
 495 #endif /* _ST_API_H_ */