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