src/egl/main/eglcontext.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 VMware, Inc.
   4  * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
   5  * Copyright 2010-2011 LunarG, Inc.
   6  * All Rights Reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the
  10  * "Software"), to deal in the Software without restriction, including
  11  * without limitation the rights to use, copy, modify, merge, publish,
  12  * distribute, sub license, and/or sell copies of the Software, and to
  13  * permit persons to whom the Software is furnished to do so, subject to
  14  * the following conditions:
  15  *
  16  * The above copyright notice and this permission notice (including the
  17  * next paragraph) shall be included in all copies or substantial portions
  18  * of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  23  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  26  * DEALINGS IN THE SOFTWARE.
  27  *
  28  **************************************************************************/
  29
  30
  31 #ifndef EGLCONTEXT_INCLUDED
  32 #define EGLCONTEXT_INCLUDED
  33
  34 #include "c99_compat.h"
  35
  36 #include "egltypedefs.h"
  37 #include "egldisplay.h"
  38
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /**
  45  * "Base" class for device driver contexts.
  46  */
  47 struct _egl_context
  48 {
  49    /* A context is a display resource */
  50    _EGLResource Resource;
  51
  52    /* The bound status of the context */
  53    _EGLThreadInfo *Binding;
  54    _EGLSurface *DrawSurface;
  55    _EGLSurface *ReadSurface;
  56
  57    _EGLConfig *Config;
  58
  59    EGLint ClientAPI; /**< EGL_OPENGL_ES_API, EGL_OPENGL_API, EGL_OPENVG_API */
  60    EGLint ClientMajorVersion;
  61    EGLint ClientMinorVersion;
  62    EGLint Flags;
  63    EGLint Profile;
  64    EGLint ResetNotificationStrategy;
  65    EGLint ContextPriority;
  66    EGLBoolean NoError;
  67
  68    /* The real render buffer when a window surface is bound */
  69    EGLint WindowRenderBuffer;
  70 };
  71
  72
  73 extern EGLBoolean
  74 _eglInitContext(_EGLContext *ctx, _EGLDisplay *dpy,
  75                 _EGLConfig *config, const EGLint *attrib_list);
  76
  77
  78 extern EGLBoolean
  79 _eglQueryContext(_EGLDriver *drv, _EGLDisplay *dpy, _EGLContext *ctx, EGLint attribute, EGLint *value);
  80
  81
  82 extern EGLBoolean
  83 _eglBindContext(_EGLContext *ctx, _EGLSurface *draw, _EGLSurface *read,
  84                 _EGLContext **old_ctx,
  85                 _EGLSurface **old_draw, _EGLSurface **old_read);
  86
  87 extern _EGLContext *
  88 _eglBindContextToThread(_EGLContext *ctx, _EGLThreadInfo *t);
  89
  90
  91 /**
  92  * Increment reference count for the context.
  93  */
  94 static inline _EGLContext *
  95 _eglGetContext(_EGLContext *ctx)
  96 {
  97    if (ctx)
  98       _eglGetResource(&ctx->Resource);
  99    return ctx;
 100 }
 101
 102
 103 /**
 104  * Decrement reference count for the context.
 105  */
 106 static inline EGLBoolean
 107 _eglPutContext(_EGLContext *ctx)
 108 {
 109    return (ctx) ? _eglPutResource(&ctx->Resource) : EGL_FALSE;
 110 }
 111
 112
 113 /**
 114  * Link a context to its display and return the handle of the link.
 115  * The handle can be passed to client directly.
 116  */
 117 static inline EGLContext
 118 _eglLinkContext(_EGLContext *ctx)
 119 {
 120    _eglLinkResource(&ctx->Resource, _EGL_RESOURCE_CONTEXT);
 121    return (EGLContext) ctx;
 122 }
 123
 124
 125 /**
 126  * Unlink a linked context from its display.
 127  * Accessing an unlinked context should generate EGL_BAD_CONTEXT error.
 128  */
 129 static inline void
 130 _eglUnlinkContext(_EGLContext *ctx)
 131 {
 132    _eglUnlinkResource(&ctx->Resource, _EGL_RESOURCE_CONTEXT);
 133 }
 134
 135
 136 /**
 137  * Lookup a handle to find the linked context.
 138  * Return NULL if the handle has no corresponding linked context.
 139  */
 140 static inline _EGLContext *
 141 _eglLookupContext(EGLContext context, _EGLDisplay *dpy)
 142 {
 143    _EGLContext *ctx = (_EGLContext *) context;
 144    if (!dpy || !_eglCheckResource((void *) ctx, _EGL_RESOURCE_CONTEXT, dpy))
 145       ctx = NULL;
 146    return ctx;
 147 }
 148
 149
 150 /**
 151  * Return the handle of a linked context, or EGL_NO_CONTEXT.
 152  */
 153 static inline EGLContext
 154 _eglGetContextHandle(_EGLContext *ctx)
 155 {
 156    _EGLResource *res = (_EGLResource *) ctx;
 157    return (res && _eglIsResourceLinked(res)) ?
 158       (EGLContext) ctx : EGL_NO_CONTEXT;
 159 }
 160
 161
 162 #ifdef __cplusplus
 163 }
 164 #endif
 165
 166 #endif /* EGLCONTEXT_INCLUDED */