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 EGLCONFIG_INCLUDED
32#define EGLCONFIG_INCLUDED
33
34
35#include <assert.h>
36#include <stddef.h>
37#include "c99_compat.h"
38
39#include "egltypedefs.h"
40
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
46/* update _eglValidationTable and _eglOffsetOfConfig before updating this
47 * struct */
48struct _egl_config
49{
50   _EGLDisplay *Display;
51
52   /* core */
53   EGLint BufferSize;
54   EGLint AlphaSize;
55   EGLint BlueSize;
56   EGLint GreenSize;
57   EGLint RedSize;
58   EGLint DepthSize;
59   EGLint StencilSize;
60   EGLint ConfigCaveat;
61   EGLint ConfigID;
62   EGLint Level;
63   EGLint MaxPbufferHeight;
64   EGLint MaxPbufferPixels;
65   EGLint MaxPbufferWidth;
66   EGLint NativeRenderable;
67   EGLint NativeVisualID;
68   EGLint NativeVisualType;
69   EGLint Samples;
70   EGLint SampleBuffers;
71   EGLint SurfaceType;
72   EGLint TransparentType;
73   EGLint TransparentBlueValue;
74   EGLint TransparentGreenValue;
75   EGLint TransparentRedValue;
76   EGLint BindToTextureRGB;
77   EGLint BindToTextureRGBA;
78   EGLint MinSwapInterval;
79   EGLint MaxSwapInterval;
80   EGLint LuminanceSize;
81   EGLint AlphaMaskSize;
82   EGLint ColorBufferType;
83   EGLint RenderableType;
84   EGLint MatchNativePixmap;
85   EGLint Conformant;
86
87   /* extensions */
88   EGLint YInvertedNOK;
89   EGLint FramebufferTargetAndroid;
90   EGLint RecordableAndroid;
91   EGLint ComponentType;
92};
93
94
95/**
96 * Map an EGL attribute enum to the offset of the member in _EGLConfig.
97 */
98static inline EGLint
99_eglOffsetOfConfig(EGLint attr)
100{
101   switch (attr) {
102#define ATTRIB_MAP(attr, memb) case attr: return offsetof(_EGLConfig, memb)
103   /* core */
104   ATTRIB_MAP(EGL_BUFFER_SIZE,               BufferSize);
105   ATTRIB_MAP(EGL_ALPHA_SIZE,                AlphaSize);
106   ATTRIB_MAP(EGL_BLUE_SIZE,                 BlueSize);
107   ATTRIB_MAP(EGL_GREEN_SIZE,                GreenSize);
108   ATTRIB_MAP(EGL_RED_SIZE,                  RedSize);
109   ATTRIB_MAP(EGL_DEPTH_SIZE,                DepthSize);
110   ATTRIB_MAP(EGL_STENCIL_SIZE,              StencilSize);
111   ATTRIB_MAP(EGL_CONFIG_CAVEAT,             ConfigCaveat);
112   ATTRIB_MAP(EGL_CONFIG_ID,                 ConfigID);
113   ATTRIB_MAP(EGL_LEVEL,                     Level);
114   ATTRIB_MAP(EGL_MAX_PBUFFER_HEIGHT,        MaxPbufferHeight);
115   ATTRIB_MAP(EGL_MAX_PBUFFER_PIXELS,        MaxPbufferPixels);
116   ATTRIB_MAP(EGL_MAX_PBUFFER_WIDTH,         MaxPbufferWidth);
117   ATTRIB_MAP(EGL_NATIVE_RENDERABLE,         NativeRenderable);
118   ATTRIB_MAP(EGL_NATIVE_VISUAL_ID,          NativeVisualID);
119   ATTRIB_MAP(EGL_NATIVE_VISUAL_TYPE,        NativeVisualType);
120   ATTRIB_MAP(EGL_SAMPLES,                   Samples);
121   ATTRIB_MAP(EGL_SAMPLE_BUFFERS,            SampleBuffers);
122   ATTRIB_MAP(EGL_SURFACE_TYPE,              SurfaceType);
123   ATTRIB_MAP(EGL_TRANSPARENT_TYPE,          TransparentType);
124   ATTRIB_MAP(EGL_TRANSPARENT_BLUE_VALUE,    TransparentBlueValue);
125   ATTRIB_MAP(EGL_TRANSPARENT_GREEN_VALUE,   TransparentGreenValue);
126   ATTRIB_MAP(EGL_TRANSPARENT_RED_VALUE,     TransparentRedValue);
127   ATTRIB_MAP(EGL_BIND_TO_TEXTURE_RGB,       BindToTextureRGB);
128   ATTRIB_MAP(EGL_BIND_TO_TEXTURE_RGBA,      BindToTextureRGBA);
129   ATTRIB_MAP(EGL_MIN_SWAP_INTERVAL,         MinSwapInterval);
130   ATTRIB_MAP(EGL_MAX_SWAP_INTERVAL,         MaxSwapInterval);
131   ATTRIB_MAP(EGL_LUMINANCE_SIZE,            LuminanceSize);
132   ATTRIB_MAP(EGL_ALPHA_MASK_SIZE,           AlphaMaskSize);
133   ATTRIB_MAP(EGL_COLOR_BUFFER_TYPE,         ColorBufferType);
134   ATTRIB_MAP(EGL_RENDERABLE_TYPE,           RenderableType);
135   ATTRIB_MAP(EGL_MATCH_NATIVE_PIXMAP,       MatchNativePixmap);
136   ATTRIB_MAP(EGL_CONFORMANT,                Conformant);
137   /* extensions */
138   ATTRIB_MAP(EGL_Y_INVERTED_NOK,            YInvertedNOK);
139   ATTRIB_MAP(EGL_FRAMEBUFFER_TARGET_ANDROID, FramebufferTargetAndroid);
140   ATTRIB_MAP(EGL_RECORDABLE_ANDROID,        RecordableAndroid);
141   ATTRIB_MAP(EGL_COLOR_COMPONENT_TYPE_EXT,  ComponentType);
142#undef ATTRIB_MAP
143   default:
144      return -1;
145   }
146}
147
148
149/**
150 * Update a config for a given key.
151 *
152 * Note that a valid key is not necessarily a valid attribute.  There are gaps
153 * in the attribute enums.  The separation is to catch application errors.
154 * Drivers should never set a key that is an invalid attribute.
155 */
156static inline void
157_eglSetConfigKey(_EGLConfig *conf, EGLint key, EGLint val)
158{
159   EGLint offset = _eglOffsetOfConfig(key);
160   assert(offset >= 0);
161   *((EGLint *) ((char *) conf + offset)) = val;
162}
163
164
165/**
166 * Return the value for a given key.
167 */
168static inline EGLint
169_eglGetConfigKey(const _EGLConfig *conf, EGLint key)
170{
171   EGLint offset = _eglOffsetOfConfig(key);
172   assert(offset >= 0);
173   return *((EGLint *) ((char *) conf + offset));
174}
175
176
177extern void
178_eglInitConfig(_EGLConfig *config, _EGLDisplay *disp, EGLint id);
179
180
181extern EGLConfig
182_eglLinkConfig(_EGLConfig *conf);
183
184
185extern _EGLConfig *
186_eglLookupConfig(EGLConfig config, _EGLDisplay *disp);
187
188
189/**
190 * Return the handle of a linked config.
191 */
192static inline EGLConfig
193_eglGetConfigHandle(_EGLConfig *conf)
194{
195   return (EGLConfig) conf;
196}
197
198
199extern EGLBoolean
200_eglValidateConfig(const _EGLConfig *conf, EGLBoolean for_matching);
201
202
203extern EGLBoolean
204_eglMatchConfig(const _EGLConfig *conf, const _EGLConfig *criteria);
205
206
207extern EGLBoolean
208_eglParseConfigAttribList(_EGLConfig *conf, _EGLDisplay *disp,
209                          const EGLint *attrib_list);
210
211
212extern EGLint
213_eglCompareConfigs(const _EGLConfig *conf1, const _EGLConfig *conf2,
214                   const _EGLConfig *criteria, EGLBoolean compare_id);
215
216
217extern EGLBoolean
218_eglFilterConfigArray(_EGLArray *array, EGLConfig *configs,
219                      EGLint config_size, EGLint *num_configs,
220                      EGLBoolean (*match)(const _EGLConfig *, void *),
221                      EGLint (*compare)(const _EGLConfig *, const _EGLConfig *,
222                                        void *),
223                      void *filter_data);
224
225
226extern EGLBoolean
227_eglChooseConfig(_EGLDriver *drv, _EGLDisplay *disp, const EGLint *attrib_list, EGLConfig *configs, EGLint config_size, EGLint *num_config);
228
229
230extern EGLBoolean
231_eglGetConfigAttrib(_EGLDriver *drv, _EGLDisplay *disp, _EGLConfig *conf, EGLint attribute, EGLint *value);
232
233
234extern EGLBoolean
235_eglGetConfigs(_EGLDriver *drv, _EGLDisplay *disp, EGLConfig *configs, EGLint config_size, EGLint *num_config);
236
237
238#ifdef __cplusplus
239}
240#endif
241
242#endif /* EGLCONFIG_INCLUDED */
243