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"
38 * Only color buffers are listed. The others are allocated privately through,
39 * for example, st_renderbuffer_alloc_storage().
41 enum native_attachment
{
42 NATIVE_ATTACHMENT_FRONT_LEFT
,
43 NATIVE_ATTACHMENT_BACK_LEFT
,
44 NATIVE_ATTACHMENT_FRONT_RIGHT
,
45 NATIVE_ATTACHMENT_BACK_RIGHT
,
47 NUM_NATIVE_ATTACHMENTS
51 * Enumerations for probe results.
53 enum native_probe_result
{
55 NATIVE_PROBE_FALLBACK
,
56 NATIVE_PROBE_SUPPORTED
,
61 * A probe object for display probe.
65 EGLNativeDisplayType display
;
68 void (*destroy
)(struct native_probe
*nprobe
);
71 struct native_surface
{
72 void (*destroy
)(struct native_surface
*nsurf
);
75 * Swap the front and back buffers so that the back buffer is visible. It
76 * is no-op if the surface is single-buffered. The contents of the back
77 * buffer after swapping may or may not be preserved.
79 boolean (*swap_buffers
)(struct native_surface
*nsurf
);
82 * Make the front buffer visible. In some native displays, changes to the
83 * front buffer might not be visible immediately and require manual flush.
85 boolean (*flush_frontbuffer
)(struct native_surface
*nsurf
);
88 * Validate the buffers of the surface. textures, if not NULL, points to an
89 * array of size NUM_NATIVE_ATTACHMENTS and the returned textures are owned
90 * by the caller. A sequence number is also returned. The caller can use
91 * it to check if anything has changed since the last call. Any of the
92 * pointers may be NULL and it indicates the caller has no interest in those
95 * If this function is called multiple times with different attachment
96 * masks, those not listed in the latest call might be destroyed. This
97 * behavior might change in the future.
99 boolean (*validate
)(struct native_surface
*nsurf
, uint attachment_mask
,
100 unsigned int *seq_num
, struct pipe_texture
**textures
,
101 int *width
, int *height
);
104 * Wait until all native commands affecting the surface has been executed.
106 void (*wait
)(struct native_surface
*nsurf
);
109 struct native_config
{
110 /* __GLcontextModes should go away some day */
111 __GLcontextModes mode
;
112 enum pipe_format color_format
;
113 enum pipe_format depth_format
;
114 enum pipe_format stencil_format
;
116 /* treat it as an additional flag to mode.drawableType */
120 struct native_connector
{
130 struct native_display_modeset
;
133 * A pipe winsys abstracts the OS. A pipe screen abstracts the graphcis
134 * hardware. A native display consists of a pipe winsys, a pipe screen, and
135 * the native display server.
137 struct native_display
{
139 * The pipe screen of the native display.
141 * Note that the "flush_frontbuffer" and "update_buffer" callbacks will be
144 struct pipe_screen
*screen
;
146 void (*destroy
)(struct native_display
*ndpy
);
149 * Get the supported configs. The configs are owned by the display, but
150 * the returned array should be free()ed.
152 * The configs will be converted to EGL config by
153 * _eglConfigFromContextModesRec and validated by _eglValidateConfig.
154 * Those failing to pass the test will be skipped.
156 const struct native_config
**(*get_configs
)(struct native_display
*ndpy
,
160 * Test if a pixmap is supported by the given config. Required unless no
161 * config has GLX_PIXMAP_BIT set.
163 * This function is usually called to find a config that supports a given
164 * pixmap. Thus, it is usually called with the same pixmap in a row.
166 boolean (*is_pixmap_supported
)(struct native_display
*ndpy
,
167 EGLNativePixmapType pix
,
168 const struct native_config
*nconf
);
171 * Create a pipe context.
173 struct pipe_context
*(*create_context
)(struct native_display
*ndpy
,
174 void *context_private
);
177 * Create a window surface. Required unless no config has GLX_WINDOW_BIT
180 struct native_surface
*(*create_window_surface
)(struct native_display
*ndpy
,
181 EGLNativeWindowType win
,
182 const struct native_config
*nconf
);
185 * Create a pixmap surface. Required unless no config has GLX_PIXMAP_BIT
188 struct native_surface
*(*create_pixmap_surface
)(struct native_display
*ndpy
,
189 EGLNativePixmapType pix
,
190 const struct native_config
*nconf
);
193 * Create a pbuffer surface. Required unless no config has GLX_PBUFFER_BIT
196 struct native_surface
*(*create_pbuffer_surface
)(struct native_display
*ndpy
,
197 const struct native_config
*nconf
,
198 uint width
, uint height
);
200 const struct native_display_modeset
*modeset
;
204 * Mode setting interface of the native display. It exposes the mode setting
205 * capabilities of the underlying graphics hardware.
207 struct native_display_modeset
{
209 * Get the available physical connectors and the number of CRTCs.
211 const struct native_connector
**(*get_connectors
)(struct native_display
*ndpy
,
216 * Get the current supported modes of a connector. The returned modes may
217 * change every time this function is called and those from previous calls
218 * might become invalid.
220 const struct native_mode
**(*get_modes
)(struct native_display
*ndpy
,
221 const struct native_connector
*nconn
,
225 * Create a scan-out surface. Required unless no config has
226 * GLX_SCREEN_BIT_MESA set.
228 struct native_surface
*(*create_scanout_surface
)(struct native_display
*ndpy
,
229 const struct native_config
*nconf
,
230 uint width
, uint height
);
233 * Program the CRTC to output the surface to the given connectors with the
234 * given mode. When surface is not given, the CRTC is disabled.
236 * This interface does not export a way to query capabilities of the CRTCs.
237 * The native display usually needs to dynamically map the index to a CRTC
238 * that supports the given connectors.
240 boolean (*program
)(struct native_display
*ndpy
, int crtc_idx
,
241 struct native_surface
*nsurf
, uint x
, uint y
,
242 const struct native_connector
**nconns
, int num_nconns
,
243 const struct native_mode
*nmode
);
247 * Test whether an attachment is set in the mask.
249 static INLINE boolean
250 native_attachment_mask_test(uint mask
, enum native_attachment att
)
252 return !!(mask
& (1 << att
));
256 * Return a probe object for the given display.
258 * Note that the returned object may be cached and used by different native
259 * display modules. It allows fast probing when multiple modules probe the
262 struct native_probe
*
263 native_create_probe(EGLNativeDisplayType dpy
);
266 * Probe the probe object.
268 enum native_probe_result
269 native_get_probe_result(struct native_probe
*nprobe
);
272 native_get_name(void);
274 struct native_display
*
275 native_create_display(EGLNativeDisplayType dpy
);
277 #endif /* _NATIVE_H_ */