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  * Value to st_manager->get_param function.
 125  */
 126 enum st_manager_param {
 127    /**
 128     * The dri state tracker on old libGL's doesn't do the right thing
 129     * with regards to invalidating the framebuffers.
 130     *
 131     * For the mesa state tracker that means that it needs to invalidate
 132     * the framebuffer in glViewport itself.
 133     */
 134    ST_MANAGER_BROKEN_INVALIDATE
 135 };
 136
 137 /**
 138  * The return type of st_api->get_proc_address.
 139  */
 140 typedef void (*st_proc_t)(void);
 141
 142 struct pipe_context;
 143 struct pipe_resource;
 144 struct pipe_fence_handle;
 145
 146 /**
 147  * Used in st_context_iface->get_resource_for_egl_image.
 148  */
 149 struct st_context_resource
 150 {
 151    /* these fields are filled by the caller */
 152    enum st_context_resource_type type;
 153    void *resource;
 154
 155    /* this is owned by the caller */
 156    struct pipe_resource *texture;
 157 };
 158
 159 /**
 160  * Used in st_manager_iface->get_egl_image.
 161  */
 162 struct st_egl_image
 163 {
 164    /* this is owned by the caller */
 165    struct pipe_resource *texture;
 166
 167    unsigned face;
 168    unsigned level;
 169    unsigned zslice;
 170 };
 171
 172 /**
 173  * Represent the visual of a framebuffer.
 174  */
 175 struct st_visual
 176 {
 177    /**
 178     * Available buffers.  Tested with ST_FRAMEBUFFER_*_MASK.
 179     */
 180    unsigned buffer_mask;
 181
 182    /**
 183     * Buffer formats.  The formats are always set even when the buffer is
 184     * not available.
 185     */
 186    enum pipe_format color_format;
 187    enum pipe_format depth_stencil_format;
 188    enum pipe_format accum_format;
 189    int samples;
 190
 191    /**
 192     * Desired render buffer.
 193     */
 194    enum st_attachment_type render_buffer;
 195 };
 196
 197 /**
 198  * Represent the attributes of a context.
 199  */
 200 struct st_context_attribs
 201 {
 202    /**
 203     * The profile and minimal version to support.
 204     *
 205     * The valid profiles and versions are rendering API dependent.  The latest
 206     * version satisfying the request should be returned, unless
 207     * forward_compatiible is true.
 208     */
 209    enum st_profile_type profile;
 210    int major, minor;
 211
 212    /**
 213     * Enable debugging.
 214     */
 215    boolean debug;
 216
 217    /**
 218     * Return the exact version and disallow the use of deprecated features.
 219     */
 220    boolean forward_compatible;
 221
 222    /**
 223     * The visual of the framebuffers the context will be bound to.
 224     */
 225    struct st_visual visual;
 226 };
 227
 228 /**
 229  * Represent a windowing system drawable.
 230  *
 231  * The framebuffer is implemented by the state tracker manager and
 232  * used by the state trackers.
 233  *
 234  * Instead of the winsys pokeing into the API context to figure
 235  * out what buffers that might be needed in the future by the API
 236  * context, it calls into the framebuffer to get the textures.
 237  *
 238  * This structure along with the notify_invalid_framebuffer
 239  * allows framebuffers to be shared between different threads
 240  * but at the same make the API context free from thread
 241  * syncronisation primitves, with the exception of a small
 242  * atomic flag used for notification of framebuffer dirty status.
 243  *
 244  * The thread syncronisation is put inside the framebuffer
 245  * and only called once the framebuffer has become dirty.
 246  */
 247 struct st_framebuffer_iface
 248 {
 249    /**
 250     * Available for the state tracker manager to use.
 251     */
 252    void *st_manager_private;
 253
 254    /**
 255     * The visual of a framebuffer.
 256     */
 257    const struct st_visual *visual;
 258
 259    /**
 260     * Flush the front buffer.
 261     *
 262     * On some window systems, changes to the front buffers are not immediately
 263     * visible.  They need to be flushed.
 264     *
 265     * @att is one of the front buffer attachments.
 266     */
 267    boolean (*flush_front)(struct st_framebuffer_iface *stfbi,
 268                           enum st_attachment_type statt);
 269
 270    /**
 271     * The state tracker asks for the textures it needs.
 272     *
 273     * It should try to only ask for attachments that it currently renders
 274     * to, thus allowing the winsys to delay the allocation of textures not
 275     * needed. For example front buffer attachments are not needed if you
 276     * only do back buffer rendering.
 277     *
 278     * The implementor of this function needs to also ensure
 279     * thread safty as this call might be done from multiple threads.
 280     *
 281     * The returned textures are owned by the caller.  They should be
 282     * unreferenced when no longer used.  If this function is called multiple
 283     * times with different sets of attachments, those buffers not included in
 284     * the last call might be destroyed.  This behavior might change in the
 285     * future.
 286     */
 287    boolean (*validate)(struct st_framebuffer_iface *stfbi,
 288                        const enum st_attachment_type *statts,
 289                        unsigned count,
 290                        struct pipe_resource **out);
 291 };
 292
 293 /**
 294  * Represent a rendering context.
 295  *
 296  * This entity is created from st_api and used by the state tracker manager.
 297  */
 298 struct st_context_iface
 299 {
 300    /**
 301     * Available for the state tracker and the manager to use.
 302     */
 303    void *st_context_private;
 304    void *st_manager_private;
 305
 306    /**
 307     * Destroy the context.
 308     */
 309    void (*destroy)(struct st_context_iface *stctxi);
 310
 311    /**
 312     * Invalidate the current textures that was taken from a framebuffer.
 313     *
 314     * The state tracker manager calls this function to let the rendering
 315     * context know that it should update the textures it got from
 316     * st_framebuffer_iface::validate.  It should do so at the latest time possible.
 317     * Possible right before sending triangles to the pipe context.
 318     *
 319     * For certain platforms this function might be called from a thread other
 320     * than the thread that the context is currently bound in, and must
 321     * therefore be thread safe. But it is the state tracker manager's
 322     * responsibility to make sure that the framebuffer is bound to the context
 323     * and the API context is current for the duration of this call.
 324     *
 325     * Thus reducing the sync primitive needed to a single atomic flag.
 326     */
 327    void (*notify_invalid_framebuffer)(struct st_context_iface *stctxi,
 328                                       struct st_framebuffer_iface *stfbi);
 329
 330    /**
 331     * Flush all drawing from context to the pipe also flushes the pipe.
 332     */
 333    void (*flush)(struct st_context_iface *stctxi, unsigned flags,
 334                  struct pipe_fence_handle **fence);
 335
 336    /**
 337     * Replace the texture image of a texture object at the specified level.
 338     *
 339     * This function is optional.
 340     */
 341    boolean (*teximage)(struct st_context_iface *stctxi, enum st_texture_type target,
 342                        int level, enum pipe_format internal_format,
 343                        struct pipe_resource *tex, boolean mipmap);
 344
 345    /**
 346     * Used to implement glXCopyContext.
 347     */
 348    void (*copy)(struct st_context_iface *stctxi,
 349                 struct st_context_iface *stsrci, unsigned mask);
 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 supported rendering API.
 406     */
 407    enum st_api_type api;
 408
 409    /**
 410     * The supported profiles.  Tested with ST_PROFILE_*_MASK.
 411     */
 412    unsigned profile_mask;
 413
 414    /**
 415     * Destroy the API.
 416     */
 417    void (*destroy)(struct st_api *stapi);
 418
 419    /**
 420     * Return an API entry point.
 421     *
 422     * For GL this is the same as _glapi_get_proc_address.
 423     */
 424    st_proc_t (*get_proc_address)(struct st_api *stapi, const char *procname);
 425
 426    /**
 427     * Create a rendering context.
 428     */
 429    struct st_context_iface *(*create_context)(struct st_api *stapi,
 430                                               struct st_manager *smapi,
 431                                               const struct st_context_attribs *attribs,
 432                                               struct st_context_iface *stsharei);
 433
 434    /**
 435     * Bind the context to the calling thread with draw and read as drawables.
 436     *
 437     * The framebuffers might be NULL, or might have different visuals than the
 438     * context does.
 439     */
 440    boolean (*make_current)(struct st_api *stapi,
 441                            struct st_context_iface *stctxi,
 442                            struct st_framebuffer_iface *stdrawi,
 443                            struct st_framebuffer_iface *streadi);
 444
 445    /**
 446     * Get the currently bound context in the calling thread.
 447     */
 448    struct st_context_iface *(*get_current)(struct st_api *stapi);
 449 };
 450
 451 /**
 452  * Return true if the visual has the specified buffers.
 453  */
 454 static INLINE boolean
 455 st_visual_have_buffers(const struct st_visual *visual, unsigned mask)
 456 {
 457    return ((visual->buffer_mask & mask) == mask);
 458 }
 459
 460 #endif /* _ST_API_H_ */