native.h revision b80b817195d47984907f46ab74d5146e91bce4cf 
1/*
2 * Mesa 3-D graphics library
3 * Version:  7.8
4 *
5 * Copyright (C) 2009-2010 Chia-I Wu <olv@0xlab.org>
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
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.
23 */
24
25#ifndef _NATIVE_H_
26#define _NATIVE_H_
27
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 */
31
32#include "pipe/p_compiler.h"
33#include "pipe/p_screen.h"
34#include "pipe/p_context.h"
35#include "pipe/p_state.h"
36
37#include "native_probe.h"
38#include "native_modeset.h"
39
40/**
41 * Only color buffers are listed.  The others are allocated privately through,
42 * for example, st_renderbuffer_alloc_storage().
43 */
44enum native_attachment {
45   NATIVE_ATTACHMENT_FRONT_LEFT,
46   NATIVE_ATTACHMENT_BACK_LEFT,
47   NATIVE_ATTACHMENT_FRONT_RIGHT,
48   NATIVE_ATTACHMENT_BACK_RIGHT,
49
50   NUM_NATIVE_ATTACHMENTS
51};
52
53enum native_param_type {
54   /*
55    * Return TRUE if window/pixmap surfaces use the buffers of the native
56    * types.
57    */
58   NATIVE_PARAM_USE_NATIVE_BUFFER
59};
60
61struct native_surface {
62   /**
63    * Available for caller's use.
64    */
65   void *user_data;
66
67   void (*destroy)(struct native_surface *nsurf);
68
69   /**
70    * Swap the front and back buffers so that the back buffer is visible.  It
71    * is no-op if the surface is single-buffered.  The contents of the back
72    * buffer after swapping may or may not be preserved.
73    */
74   boolean (*swap_buffers)(struct native_surface *nsurf);
75
76   /**
77    * Make the front buffer visible.  In some native displays, changes to the
78    * front buffer might not be visible immediately and require manual flush.
79    */
80   boolean (*flush_frontbuffer)(struct native_surface *nsurf);
81
82   /**
83    * Validate the buffers of the surface.  textures, if not NULL, points to an
84    * array of size NUM_NATIVE_ATTACHMENTS and the returned textures are owned
85    * by the caller.  A sequence number is also returned.  The caller can use
86    * it to check if anything has changed since the last call. Any of the
87    * pointers may be NULL and it indicates the caller has no interest in those
88    * values.
89    *
90    * If this function is called multiple times with different attachment
91    * masks, those not listed in the latest call might be destroyed.  This
92    * behavior might change in the future.
93    */
94   boolean (*validate)(struct native_surface *nsurf, uint attachment_mask,
95                       unsigned int *seq_num, struct pipe_texture **textures,
96                       int *width, int *height);
97
98   /**
99    * Wait until all native commands affecting the surface has been executed.
100    */
101   void (*wait)(struct native_surface *nsurf);
102};
103
104struct native_config {
105   /* __GLcontextModes should go away some day */
106   __GLcontextModes mode;
107   enum pipe_format color_format;
108   enum pipe_format depth_format;
109   enum pipe_format stencil_format;
110
111   /* treat it as an additional flag to mode.drawableType */
112   boolean scanout_bit;
113};
114
115/**
116 * A pipe winsys abstracts the OS.  A pipe screen abstracts the graphcis
117 * hardware.  A native display consists of a pipe winsys, a pipe screen, and
118 * the native display server.
119 */
120struct native_display {
121   /**
122    * The pipe screen of the native display.
123    */
124   struct pipe_screen *screen;
125
126   /**
127    * Available for caller's use.
128    */
129   void *user_data;
130
131   void (*destroy)(struct native_display *ndpy);
132
133   /**
134    * Query the parameters of the native display.
135    *
136    * The return value is defined by the parameter.
137    */
138   int (*get_param)(struct native_display *ndpy,
139                    enum native_param_type param);
140
141   /**
142    * Get the supported configs.  The configs are owned by the display, but
143    * the returned array should be free()ed.
144    *
145    * The configs will be converted to EGL config by
146    * _eglConfigFromContextModesRec and validated by _eglValidateConfig.
147    * Those failing to pass the test will be skipped.
148    */
149   const struct native_config **(*get_configs)(struct native_display *ndpy,
150                                               int *num_configs);
151
152   /**
153    * Test if a pixmap is supported by the given config.  Required unless no
154    * config has GLX_PIXMAP_BIT set.
155    *
156    * This function is usually called to find a config that supports a given
157    * pixmap.  Thus, it is usually called with the same pixmap in a row.
158    */
159   boolean (*is_pixmap_supported)(struct native_display *ndpy,
160                                  EGLNativePixmapType pix,
161                                  const struct native_config *nconf);
162
163
164   /**
165    * Create a window surface.  Required unless no config has GLX_WINDOW_BIT
166    * set.
167    */
168   struct native_surface *(*create_window_surface)(struct native_display *ndpy,
169                                                   EGLNativeWindowType win,
170                                                   const struct native_config *nconf);
171
172   /**
173    * Create a pixmap surface.  Required unless no config has GLX_PIXMAP_BIT
174    * set.
175    */
176   struct native_surface *(*create_pixmap_surface)(struct native_display *ndpy,
177                                                   EGLNativePixmapType pix,
178                                                   const struct native_config *nconf);
179
180   const struct native_display_modeset *modeset;
181};
182
183/**
184 * The handler for events that a native display may generate.  The events are
185 * generated asynchronously and the handler may be called by any thread at any
186 * time.
187 */
188struct native_event_handler {
189   /**
190    * This function is called when a surface needs to be validated.
191    */
192   void (*invalid_surface)(struct native_display *ndpy,
193                           struct native_surface *nsurf,
194                           unsigned int seq_num);
195};
196
197/**
198 * Test whether an attachment is set in the mask.
199 */
200static INLINE boolean
201native_attachment_mask_test(uint mask, enum native_attachment att)
202{
203   return !!(mask & (1 << att));
204}
205
206const char *
207native_get_name(void);
208
209struct native_display *
210native_create_display(EGLNativeDisplayType dpy,
211                      struct native_event_handler *handler);
212
213#endif /* _NATIVE_H_ */
214