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