2 * Mesa 3-D graphics library
5 * Copyright (C) 2009-2010 Chia-I Wu <olv@0xlab.org>
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 #include "EGL/egl.h" /* for EGL native types */
29 #include "GL/gl.h" /* for GL types needed by __GLcontextModes */
30 #include "GL/internal/glcore.h" /* for __GLcontextModes */
32 #include "pipe/p_compiler.h"
33 #include "pipe/p_screen.h"
34 #include "pipe/p_context.h"
35 #include "pipe/p_state.h"
37 #include "native_modeset.h"
40 * Only color buffers are listed. The others are allocated privately through,
41 * for example, st_renderbuffer_alloc_storage().
43 enum native_attachment
{
44 NATIVE_ATTACHMENT_FRONT_LEFT
,
45 NATIVE_ATTACHMENT_BACK_LEFT
,
46 NATIVE_ATTACHMENT_FRONT_RIGHT
,
47 NATIVE_ATTACHMENT_BACK_RIGHT
,
49 NUM_NATIVE_ATTACHMENTS
52 enum native_param_type
{
54 * Return TRUE if window/pixmap surfaces use the buffers of the native
57 NATIVE_PARAM_USE_NATIVE_BUFFER
61 * Enumerations for probe results.
63 enum native_probe_result
{
65 NATIVE_PROBE_FALLBACK
,
66 NATIVE_PROBE_SUPPORTED
,
71 * A probe object for display probe.
75 EGLNativeDisplayType display
;
78 void (*destroy
)(struct native_probe
*nprobe
);
81 struct native_surface
{
83 * Available for caller's use.
87 void (*destroy
)(struct native_surface
*nsurf
);
90 * Swap the front and back buffers so that the back buffer is visible. It
91 * is no-op if the surface is single-buffered. The contents of the back
92 * buffer after swapping may or may not be preserved.
94 boolean (*swap_buffers
)(struct native_surface
*nsurf
);
97 * Make the front buffer visible. In some native displays, changes to the
98 * front buffer might not be visible immediately and require manual flush.
100 boolean (*flush_frontbuffer
)(struct native_surface
*nsurf
);
103 * Validate the buffers of the surface. textures, if not NULL, points to an
104 * array of size NUM_NATIVE_ATTACHMENTS and the returned textures are owned
105 * by the caller. A sequence number is also returned. The caller can use
106 * it to check if anything has changed since the last call. Any of the
107 * pointers may be NULL and it indicates the caller has no interest in those
110 * If this function is called multiple times with different attachment
111 * masks, those not listed in the latest call might be destroyed. This
112 * behavior might change in the future.
114 boolean (*validate
)(struct native_surface
*nsurf
, uint attachment_mask
,
115 unsigned int *seq_num
, struct pipe_texture
**textures
,
116 int *width
, int *height
);
119 * Wait until all native commands affecting the surface has been executed.
121 void (*wait
)(struct native_surface
*nsurf
);
124 struct native_config
{
125 /* __GLcontextModes should go away some day */
126 __GLcontextModes mode
;
127 enum pipe_format color_format
;
128 enum pipe_format depth_format
;
129 enum pipe_format stencil_format
;
131 /* treat it as an additional flag to mode.drawableType */
136 * A pipe winsys abstracts the OS. A pipe screen abstracts the graphcis
137 * hardware. A native display consists of a pipe winsys, a pipe screen, and
138 * the native display server.
140 struct native_display
{
142 * The pipe screen of the native display.
144 struct pipe_screen
*screen
;
147 * Available for caller's use.
151 void (*destroy
)(struct native_display
*ndpy
);
154 * Query the parameters of the native display.
156 * The return value is defined by the parameter.
158 int (*get_param
)(struct native_display
*ndpy
,
159 enum native_param_type param
);
162 * Get the supported configs. The configs are owned by the display, but
163 * the returned array should be free()ed.
165 * The configs will be converted to EGL config by
166 * _eglConfigFromContextModesRec and validated by _eglValidateConfig.
167 * Those failing to pass the test will be skipped.
169 const struct native_config
**(*get_configs
)(struct native_display
*ndpy
,
173 * Test if a pixmap is supported by the given config. Required unless no
174 * config has GLX_PIXMAP_BIT set.
176 * This function is usually called to find a config that supports a given
177 * pixmap. Thus, it is usually called with the same pixmap in a row.
179 boolean (*is_pixmap_supported
)(struct native_display
*ndpy
,
180 EGLNativePixmapType pix
,
181 const struct native_config
*nconf
);
185 * Create a window surface. Required unless no config has GLX_WINDOW_BIT
188 struct native_surface
*(*create_window_surface
)(struct native_display
*ndpy
,
189 EGLNativeWindowType win
,
190 const struct native_config
*nconf
);
193 * Create a pixmap surface. Required unless no config has GLX_PIXMAP_BIT
196 struct native_surface
*(*create_pixmap_surface
)(struct native_display
*ndpy
,
197 EGLNativePixmapType pix
,
198 const struct native_config
*nconf
);
201 * Create a pbuffer surface. Required unless no config has GLX_PBUFFER_BIT
204 struct native_surface
*(*create_pbuffer_surface
)(struct native_display
*ndpy
,
205 const struct native_config
*nconf
,
206 uint width
, uint height
);
208 const struct native_display_modeset
*modeset
;
212 * The handler for events that a native display may generate. The events are
213 * generated asynchronously and the handler may be called by any thread at any
216 struct native_event_handler
{
218 * This function is called when a surface needs to be validated.
220 void (*invalid_surface
)(struct native_display
*ndpy
,
221 struct native_surface
*nsurf
,
222 unsigned int seq_num
);
226 * Test whether an attachment is set in the mask.
228 static INLINE boolean
229 native_attachment_mask_test(uint mask
, enum native_attachment att
)
231 return !!(mask
& (1 << att
));
235 * Return a probe object for the given display.
237 * Note that the returned object may be cached and used by different native
238 * display modules. It allows fast probing when multiple modules probe the
241 struct native_probe
*
242 native_create_probe(EGLNativeDisplayType dpy
);
245 * Probe the probe object.
247 enum native_probe_result
248 native_get_probe_result(struct native_probe
*nprobe
);
251 native_get_name(void);
253 struct native_display
*
254 native_create_display(EGLNativeDisplayType dpy
,
255 struct native_event_handler
*handler
);
257 #endif /* _NATIVE_H_ */