Home | History | Annotate | Download | only in main
      1 /**************************************************************************
      2  *
      3  * Copyright 2008 VMware, Inc.
      4  * Copyright 2009-2010 Chia-I Wu <olvaffe (at) 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 #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 surfaces.
     46  */
     47 struct _egl_surface
     48 {
     49    /* A surface is a display resource */
     50    _EGLResource Resource;
     51 
     52    /* The context that is currently bound to the surface */
     53    _EGLContext *CurrentContext;
     54 
     55    _EGLConfig *Config;
     56 
     57    EGLint Type; /* one of EGL_WINDOW_BIT, EGL_PIXMAP_BIT or EGL_PBUFFER_BIT */
     58 
     59    /* The native surface is lost. The EGL spec requires certain functions
     60     * to generate EGL_BAD_NATIVE_WINDOW when given this surface.
     61     */
     62    EGLBoolean Lost;
     63 
     64    /* attributes set by attribute list */
     65    EGLint Width, Height;
     66    EGLenum TextureFormat;
     67    EGLenum TextureTarget;
     68    EGLBoolean MipmapTexture;
     69    EGLBoolean LargestPbuffer;
     70    EGLenum RenderBuffer;
     71    EGLenum VGAlphaFormat;
     72    EGLenum VGColorspace;
     73    EGLenum GLColorspace;
     74 
     75    /* attributes set by eglSurfaceAttrib */
     76    EGLint MipmapLevel;
     77    EGLenum MultisampleResolve;
     78    EGLenum SwapBehavior;
     79 
     80    EGLint HorizontalResolution, VerticalResolution;
     81    EGLint AspectRatio;
     82 
     83    EGLint SwapInterval;
     84 
     85    /* EGL_KHR_partial_update
     86     * True if the damage region is already set
     87     * between frame boundaries.
     88     */
     89    EGLBoolean SetDamageRegionCalled;
     90 
     91    /* EGL_KHR_partial_update
     92     * True if the buffer age is read by the client
     93     * between frame boundaries.
     94     */
     95    EGLBoolean BufferAgeRead;
     96 
     97    /* True if the surface is bound to an OpenGL ES texture */
     98    EGLBoolean BoundToTexture;
     99 
    100    EGLBoolean PostSubBufferSupportedNV;
    101 };
    102 
    103 
    104 extern EGLBoolean
    105 _eglInitSurface(_EGLSurface *surf, _EGLDisplay *dpy, EGLint type,
    106                 _EGLConfig *config, const EGLint *attrib_list);
    107 
    108 
    109 extern EGLBoolean
    110 _eglQuerySurface(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint attribute, EGLint *value);
    111 
    112 
    113 extern EGLBoolean
    114 _eglSurfaceAttrib(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint attribute, EGLint value);
    115 
    116 
    117 extern EGLBoolean
    118 _eglBindTexImage(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint buffer);
    119 
    120 extern EGLBoolean
    121 _eglReleaseTexImage(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf, EGLint buffer);
    122 
    123 
    124 extern EGLBoolean
    125 _eglSwapInterval(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint interval);
    126 
    127 
    128 /**
    129  * Increment reference count for the surface.
    130  */
    131 static inline _EGLSurface *
    132 _eglGetSurface(_EGLSurface *surf)
    133 {
    134    if (surf)
    135       _eglGetResource(&surf->Resource);
    136    return surf;
    137 }
    138 
    139 
    140 /**
    141  * Decrement reference count for the surface.
    142  */
    143 static inline EGLBoolean
    144 _eglPutSurface(_EGLSurface *surf)
    145 {
    146    return (surf) ? _eglPutResource(&surf->Resource) : EGL_FALSE;
    147 }
    148 
    149 
    150 /**
    151  * Link a surface to its display and return the handle of the link.
    152  * The handle can be passed to client directly.
    153  */
    154 static inline EGLSurface
    155 _eglLinkSurface(_EGLSurface *surf)
    156 {
    157    _eglLinkResource(&surf->Resource, _EGL_RESOURCE_SURFACE);
    158    return (EGLSurface) surf;
    159 }
    160 
    161 
    162 /**
    163  * Unlink a linked surface from its display.
    164  * Accessing an unlinked surface should generate EGL_BAD_SURFACE error.
    165  */
    166 static inline void
    167 _eglUnlinkSurface(_EGLSurface *surf)
    168 {
    169    _eglUnlinkResource(&surf->Resource, _EGL_RESOURCE_SURFACE);
    170 }
    171 
    172 
    173 /**
    174  * Lookup a handle to find the linked surface.
    175  * Return NULL if the handle has no corresponding linked surface.
    176  */
    177 static inline _EGLSurface *
    178 _eglLookupSurface(EGLSurface surface, _EGLDisplay *dpy)
    179 {
    180    _EGLSurface *surf = (_EGLSurface *) surface;
    181    if (!dpy || !_eglCheckResource((void *) surf, _EGL_RESOURCE_SURFACE, dpy))
    182       surf = NULL;
    183    return surf;
    184 }
    185 
    186 
    187 /**
    188  * Return the handle of a linked surface, or EGL_NO_SURFACE.
    189  */
    190 static inline EGLSurface
    191 _eglGetSurfaceHandle(_EGLSurface *surf)
    192 {
    193    _EGLResource *res = (_EGLResource *) surf;
    194    return (res && _eglIsResourceLinked(res)) ?
    195       (EGLSurface) surf : EGL_NO_SURFACE;
    196 }
    197 
    198 
    199 #ifdef __cplusplus
    200 }
    201 #endif
    202 
    203 #endif /* EGLSURFACE_INCLUDED */
    204