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    EGLBoolean NoError;
  66
  67    /* The real render buffer when a window surface is bound */
  68    EGLint WindowRenderBuffer;
  69 };
  70
  71
  72 extern EGLBoolean
  73 _eglInitContext(_EGLContext *ctx, _EGLDisplay *dpy,
  74                 _EGLConfig *config, const EGLint *attrib_list);
  75
  76
  77 extern EGLBoolean
  78 _eglQueryContext(_EGLDriver *drv, _EGLDisplay *dpy, _EGLContext *ctx, EGLint attribute, EGLint *value);
  79
  80
  81 extern EGLBoolean
  82 _eglBindContext(_EGLContext *ctx, _EGLSurface *draw, _EGLSurface *read,
  83                 _EGLContext **old_ctx,
  84                 _EGLSurface **old_draw, _EGLSurface **old_read);
  85
  86 extern _EGLContext *
  87 _eglBindContextToThread(_EGLContext *ctx, _EGLThreadInfo *t);
  88
  89
  90 /**
  91  * Increment reference count for the context.
  92  */
  93 static inline _EGLContext *
  94 _eglGetContext(_EGLContext *ctx)
  95 {
  96    if (ctx)
  97       _eglGetResource(&ctx->Resource);
  98    return ctx;
  99 }
 100
 101
 102 /**
 103  * Decrement reference count for the context.
 104  */
 105 static inline EGLBoolean
 106 _eglPutContext(_EGLContext *ctx)
 107 {
 108    return (ctx) ? _eglPutResource(&ctx->Resource) : EGL_FALSE;
 109 }
 110
 111
 112 /**
 113  * Link a context to its display and return the handle of the link.
 114  * The handle can be passed to client directly.
 115  */
 116 static inline EGLContext
 117 _eglLinkContext(_EGLContext *ctx)
 118 {
 119    _eglLinkResource(&ctx->Resource, _EGL_RESOURCE_CONTEXT);
 120    return (EGLContext) ctx;
 121 }
 122
 123
 124 /**
 125  * Unlink a linked context from its display.
 126  * Accessing an unlinked context should generate EGL_BAD_CONTEXT error.
 127  */
 128 static inline void
 129 _eglUnlinkContext(_EGLContext *ctx)
 130 {
 131    _eglUnlinkResource(&ctx->Resource, _EGL_RESOURCE_CONTEXT);
 132 }
 133
 134
 135 /**
 136  * Lookup a handle to find the linked context.
 137  * Return NULL if the handle has no corresponding linked context.
 138  */
 139 static inline _EGLContext *
 140 _eglLookupContext(EGLContext context, _EGLDisplay *dpy)
 141 {
 142    _EGLContext *ctx = (_EGLContext *) context;
 143    if (!dpy || !_eglCheckResource((void *) ctx, _EGL_RESOURCE_CONTEXT, dpy))
 144       ctx = NULL;
 145    return ctx;
 146 }
 147
 148
 149 /**
 150  * Return the handle of a linked context, or EGL_NO_CONTEXT.
 151  */
 152 static inline EGLContext
 153 _eglGetContextHandle(_EGLContext *ctx)
 154 {
 155    _EGLResource *res = (_EGLResource *) ctx;
 156    return (res && _eglIsResourceLinked(res)) ?
 157       (EGLContext) ctx : EGL_NO_CONTEXT;
 158 }
 159
 160
 161 #ifdef __cplusplus
 162 }
 163 #endif
 164
 165 #endif /* EGLCONTEXT_INCLUDED */