src/egl/main/eglsurface.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 VMware, Inc.
   4  * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
   5  * Copyright 2010 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 EGLSURFACE_INCLUDED
  32 #define EGLSURFACE_INCLUDED
  33
  34
  35 #include "egltypedefs.h"
  36 #include "egldisplay.h"
  37
  38
  39 /**
  40  * "Base" class for device driver surfaces.
  41  */
  42 struct _egl_surface
  43 {
  44    /* A surface is a display resource */
  45    _EGLResource Resource;
  46
  47    /* The context that is currently bound to the surface */
  48    _EGLContext *CurrentContext;
  49
  50    _EGLConfig *Config;
  51
  52    EGLint Type; /* one of EGL_WINDOW_BIT, EGL_PIXMAP_BIT or EGL_PBUFFER_BIT */
  53
  54    /* attributes set by attribute list */
  55    EGLint Width, Height;
  56    EGLenum TextureFormat;
  57    EGLenum TextureTarget;
  58    EGLBoolean MipmapTexture;
  59    EGLBoolean LargestPbuffer;
  60    EGLenum RenderBuffer;
  61    EGLenum VGAlphaFormat;
  62    EGLenum VGColorspace;
  63
  64    /* attributes set by eglSurfaceAttrib */
  65    EGLint MipmapLevel;
  66    EGLenum MultisampleResolve;
  67    EGLenum SwapBehavior;
  68
  69    EGLint HorizontalResolution, VerticalResolution;
  70    EGLint AspectRatio;
  71
  72    EGLint SwapInterval;
  73
  74    /* True if the surface is bound to an OpenGL ES texture */
  75    EGLBoolean BoundToTexture;
  76
  77    EGLBoolean PostSubBufferSupportedNV;
  78 };
  79
  80
  81 PUBLIC EGLBoolean
  82 _eglInitSurface(_EGLSurface *surf, _EGLDisplay *dpy, EGLint type,
  83                 _EGLConfig *config, const EGLint *attrib_list);
  84
  85
  86 extern EGLBoolean
  87 _eglQuerySurface(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint attribute, EGLint *value);
  88
  89
  90 extern EGLBoolean
  91 _eglSurfaceAttrib(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint attribute, EGLint value);
  92
  93
  94 PUBLIC extern EGLBoolean
  95 _eglBindTexImage(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint buffer);
  96
  97 PUBLIC extern EGLBoolean
  98 _eglReleaseTexImage(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf, EGLint buffer);
  99
 100
 101 extern EGLBoolean
 102 _eglSwapInterval(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint interval);
 103
 104
 105 /**
 106  * Increment reference count for the surface.
 107  */
 108 static INLINE _EGLSurface *
 109 _eglGetSurface(_EGLSurface *surf)
 110 {
 111    if (surf)
 112       _eglGetResource(&surf->Resource);
 113    return surf;
 114 }
 115
 116
 117 /**
 118  * Decrement reference count for the surface.
 119  */
 120 static INLINE EGLBoolean
 121 _eglPutSurface(_EGLSurface *surf)
 122 {
 123    return (surf) ? _eglPutResource(&surf->Resource) : EGL_FALSE;
 124 }
 125
 126
 127 /**
 128  * Link a surface to its display and return the handle of the link.
 129  * The handle can be passed to client directly.
 130  */
 131 static INLINE EGLSurface
 132 _eglLinkSurface(_EGLSurface *surf)
 133 {
 134    _eglLinkResource(&surf->Resource, _EGL_RESOURCE_SURFACE);
 135    return (EGLSurface) surf;
 136 }
 137
 138
 139 /**
 140  * Unlink a linked surface from its display.
 141  * Accessing an unlinked surface should generate EGL_BAD_SURFACE error.
 142  */
 143 static INLINE void
 144 _eglUnlinkSurface(_EGLSurface *surf)
 145 {
 146    _eglUnlinkResource(&surf->Resource, _EGL_RESOURCE_SURFACE);
 147 }
 148
 149
 150 /**
 151  * Lookup a handle to find the linked surface.
 152  * Return NULL if the handle has no corresponding linked surface.
 153  */
 154 static INLINE _EGLSurface *
 155 _eglLookupSurface(EGLSurface surface, _EGLDisplay *dpy)
 156 {
 157    _EGLSurface *surf = (_EGLSurface *) surface;
 158    if (!dpy || !_eglCheckResource((void *) surf, _EGL_RESOURCE_SURFACE, dpy))
 159       surf = NULL;
 160    return surf;
 161 }
 162
 163
 164 /**
 165  * Return the handle of a linked surface, or EGL_NO_SURFACE.
 166  */
 167 static INLINE EGLSurface
 168 _eglGetSurfaceHandle(_EGLSurface *surf)
 169 {
 170    _EGLResource *res = (_EGLResource *) surf;
 171    return (res && _eglIsResourceLinked(res)) ?
 172       (EGLSurface) surf : EGL_NO_SURFACE;
 173 }
 174
 175
 176 #endif /* EGLSURFACE_INCLUDED */