eglsurface.h revision 3464ebd5 
1/**************************************************************************
2 *
3 * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
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 */
42struct _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
78
79PUBLIC EGLBoolean
80_eglInitSurface(_EGLSurface *surf, _EGLDisplay *dpy, EGLint type,
81                _EGLConfig *config, const EGLint *attrib_list);
82
83
84extern EGLBoolean
85_eglQuerySurface(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint attribute, EGLint *value);
86
87
88extern EGLBoolean
89_eglSurfaceAttrib(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint attribute, EGLint value);
90
91
92PUBLIC extern EGLBoolean
93_eglBindTexImage(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint buffer);
94
95
96extern EGLBoolean
97_eglSwapInterval(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint interval);
98
99
100/**
101 * Increment reference count for the surface.
102 */
103static INLINE _EGLSurface *
104_eglGetSurface(_EGLSurface *surf)
105{
106   if (surf)
107      _eglGetResource(&surf->Resource);
108   return surf;
109}
110
111
112/**
113 * Decrement reference count for the surface.
114 */
115static INLINE EGLBoolean
116_eglPutSurface(_EGLSurface *surf)
117{
118   return (surf) ? _eglPutResource(&surf->Resource) : EGL_FALSE;
119}
120
121
122/**
123 * Link a surface to its display and return the handle of the link.
124 * The handle can be passed to client directly.
125 */
126static INLINE EGLSurface
127_eglLinkSurface(_EGLSurface *surf)
128{
129   _eglLinkResource(&surf->Resource, _EGL_RESOURCE_SURFACE);
130   return (EGLSurface) surf;
131}
132
133
134/**
135 * Unlink a linked surface from its display.
136 * Accessing an unlinked surface should generate EGL_BAD_SURFACE error.
137 */
138static INLINE void
139_eglUnlinkSurface(_EGLSurface *surf)
140{
141   _eglUnlinkResource(&surf->Resource, _EGL_RESOURCE_SURFACE);
142}
143
144
145/**
146 * Lookup a handle to find the linked surface.
147 * Return NULL if the handle has no corresponding linked surface.
148 */
149static INLINE _EGLSurface *
150_eglLookupSurface(EGLSurface surface, _EGLDisplay *dpy)
151{
152   _EGLSurface *surf = (_EGLSurface *) surface;
153   if (!dpy || !_eglCheckResource((void *) surf, _EGL_RESOURCE_SURFACE, dpy))
154      surf = NULL;
155   return surf;
156}
157
158
159/**
160 * Return the handle of a linked surface, or EGL_NO_SURFACE.
161 */
162static INLINE EGLSurface
163_eglGetSurfaceHandle(_EGLSurface *surf)
164{
165   _EGLResource *res = (_EGLResource *) surf;
166   return (res && _eglIsResourceLinked(res)) ?
167      (EGLSurface) surf : EGL_NO_SURFACE;
168}
169
170
171#endif /* EGLSURFACE_INCLUDED */
172