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 OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23 * DEALINGS IN THE SOFTWARE.
29 #include "EGL/egl.h" /* for EGL native types */
31 #include "pipe/p_compiler.h"
32 #include "pipe/p_screen.h"
33 #include "pipe/p_context.h"
34 #include "pipe/p_state.h"
35 #include "state_tracker/sw_winsys.h"
41 #include "native_buffer.h"
42 #include "native_modeset.h"
45 * Only color buffers are listed. The others are allocated privately through,
46 * for example, st_renderbuffer_alloc_storage().
48 enum native_attachment
{
49 NATIVE_ATTACHMENT_FRONT_LEFT
,
50 NATIVE_ATTACHMENT_BACK_LEFT
,
51 NATIVE_ATTACHMENT_FRONT_RIGHT
,
52 NATIVE_ATTACHMENT_BACK_RIGHT
,
54 NUM_NATIVE_ATTACHMENTS
57 enum native_param_type
{
59 * Return TRUE if window/pixmap surfaces use the buffers of the native
62 NATIVE_PARAM_USE_NATIVE_BUFFER
,
65 * Return TRUE if native_surface::present can preserve the buffer.
67 NATIVE_PARAM_PRESERVE_BUFFER
,
70 * Return the maximum supported swap interval.
72 NATIVE_PARAM_MAX_SWAP_INTERVAL
75 struct native_surface
{
77 * Available for caller's use.
81 void (*destroy
)(struct native_surface
*nsurf
);
84 * Present the given buffer to the native engine.
86 boolean (*present
)(struct native_surface
*nsurf
,
87 enum native_attachment natt
,
92 * Validate the buffers of the surface. textures, if not NULL, points to an
93 * array of size NUM_NATIVE_ATTACHMENTS and the returned textures are owned
94 * by the caller. A sequence number is also returned. The caller can use
95 * it to check if anything has changed since the last call. Any of the
96 * pointers may be NULL and it indicates the caller has no interest in those
99 * If this function is called multiple times with different attachment
100 * masks, those not listed in the latest call might be destroyed. This
101 * behavior might change in the future.
103 boolean (*validate
)(struct native_surface
*nsurf
, uint attachment_mask
,
104 unsigned int *seq_num
, struct pipe_resource
**textures
,
105 int *width
, int *height
);
108 * Wait until all native commands affecting the surface has been executed.
110 void (*wait
)(struct native_surface
*nsurf
);
114 * Describe a native display config.
116 struct native_config
{
117 /* available buffers and their format */
119 enum pipe_format color_format
;
121 /* supported surface types */
126 int native_visual_id
;
127 int native_visual_type
;
129 boolean transparent_rgb
;
130 int transparent_rgb_values
[3];
134 * A pipe winsys abstracts the OS. A pipe screen abstracts the graphcis
135 * hardware. A native display consists of a pipe winsys, a pipe screen, and
136 * the native display server.
138 struct native_display
{
140 * The pipe screen of the native display.
142 struct pipe_screen
*screen
;
145 * Available for caller's use.
149 void (*destroy
)(struct native_display
*ndpy
);
152 * Query the parameters of the native display.
154 * The return value is defined by the parameter.
156 int (*get_param
)(struct native_display
*ndpy
,
157 enum native_param_type param
);
160 * Get the supported configs. The configs are owned by the display, but
161 * the returned array should be FREE()ed.
163 const struct native_config
**(*get_configs
)(struct native_display
*ndpy
,
167 * Test if a pixmap is supported by the given config. Required unless no
168 * config has pixmap_bit set.
170 * This function is usually called to find a config that supports a given
171 * pixmap. Thus, it is usually called with the same pixmap in a row.
173 boolean (*is_pixmap_supported
)(struct native_display
*ndpy
,
174 EGLNativePixmapType pix
,
175 const struct native_config
*nconf
);
179 * Create a window surface. Required unless no config has window_bit set.
181 struct native_surface
*(*create_window_surface
)(struct native_display
*ndpy
,
182 EGLNativeWindowType win
,
183 const struct native_config
*nconf
);
186 * Create a pixmap surface. The native config may be NULL. In that case, a
187 * "best config" will be picked. Required unless no config has pixmap_bit
190 struct native_surface
*(*create_pixmap_surface
)(struct native_display
*ndpy
,
191 EGLNativePixmapType pix
,
192 const struct native_config
*nconf
);
194 const struct native_display_buffer
*buffer
;
195 const struct native_display_modeset
*modeset
;
199 * The handler for events that a native display may generate. The events are
200 * generated asynchronously and the handler may be called by any thread at any
203 struct native_event_handler
{
205 * This function is called when a surface needs to be validated.
207 void (*invalid_surface
)(struct native_display
*ndpy
,
208 struct native_surface
*nsurf
,
209 unsigned int seq_num
);
211 struct pipe_screen
*(*new_drm_screen
)(struct native_display
*ndpy
,
212 const char *name
, int fd
);
213 struct pipe_screen
*(*new_sw_screen
)(struct native_display
*ndpy
,
214 struct sw_winsys
*ws
);
218 * Test whether an attachment is set in the mask.
220 static INLINE boolean
221 native_attachment_mask_test(uint mask
, enum native_attachment att
)
223 return !!(mask
& (1 << att
));
226 struct native_platform
{
229 void (*set_event_handler
)(struct native_event_handler
*handler
);
230 struct native_display
*(*create_display
)(void *dpy
,
235 const struct native_platform
*
236 native_get_gdi_platform(void);
238 const struct native_platform
*
239 native_get_x11_platform(void);
241 const struct native_platform
*
242 native_get_wayland_platform(void);
244 const struct native_platform
*
245 native_get_drm_platform(void);
247 const struct native_platform
*
248 native_get_fbdev_platform(void);
254 #endif /* _NATIVE_H_ */