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