2 * Copyright 1998-1999 Precision Insight, Inc., Cedar Park, Texas.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sub license, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial portions
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
20 * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
21 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 * DRI utility functions definitions.
30 * This module acts as glue between GLX and the actual hardware driver. A DRI
31 * driver doesn't really \e have to use any of this - it's optional. But, some
32 * useful stuff is done here that otherwise would have to be duplicated in most
35 * Basically, these utility functions take care of some of the dirty details of
36 * screen initialization, context creation, context binding, DRM setup, etc.
38 * These functions are compiled into each DRI driver so libGL.so knows nothing
43 * \author Kevin E. Martin <kevin@precisioninsight.com>
44 * \author Brian Paul <brian@precisioninsight.com>
48 * The following structs are shared between DRISW and DRI2, the DRISW structs
49 * are essentially base classes of the DRI2 structs. DRISW needs to compile on
50 * platforms without DRM, so keep the structs opaque to DRM.
57 #include <GL/internal/dri_interface.h>
58 #include "main/menums.h"
59 #include "main/formats.h"
60 #include "util/xmlconfig.h"
69 extern const __DRIcoreExtension driCoreExtension
;
70 extern const __DRIswrastExtension driSWRastExtension
;
71 extern const __DRIdri2Extension driDRI2Extension
;
72 extern const __DRI2configQueryExtension dri2ConfigQueryExtension
;
73 extern const __DRIcopySubBufferExtension driCopySubBufferExtension
;
74 extern const __DRI2flushControlExtension dri2FlushControlExtension
;
77 * Description of the attributes used to create a config.
79 * This is passed as the context_config parameter to CreateContext. The idea
80 * with this struct is that it can be extended without having to modify all of
81 * the drivers. The first three members (major/minor_version and flags) are
82 * always valid, but the remaining members are only valid if the corresponding
83 * flag is set for the attribute. If the flag is not set then the default
84 * value should be assumed. That way the driver can quickly check if any
85 * attributes were set that it doesn't understand and report an error.
87 struct __DriverContextConfig
{
88 /* These members are always valid */
89 unsigned major_version
;
90 unsigned minor_version
;
93 /* Flags describing which of the remaining members are valid */
94 uint32_t attribute_mask
;
96 /* Only valid if __DRIVER_CONTEXT_ATTRIB_RESET_STRATEGY is set */
99 /* Only valid if __DRIVER_CONTEXT_PRIORITY is set */
102 /* Only valid if __DRIVER_CONTEXT_ATTRIB_RELEASE_BEHAVIOR is set */
103 int release_behavior
;
106 #define __DRIVER_CONTEXT_ATTRIB_RESET_STRATEGY (1 << 0)
107 #define __DRIVER_CONTEXT_ATTRIB_PRIORITY (1 << 1)
108 #define __DRIVER_CONTEXT_ATTRIB_RELEASE_BEHAVIOR (1 << 2)
111 * Driver callback functions.
113 * Each DRI driver must have one of these structures with all the pointers set
114 * to appropriate functions within the driver.
116 * When glXCreateContext() is called, for example, it'll call a helper function
117 * dri_util.c which in turn will jump through the \a CreateContext pointer in
120 struct __DriverAPIRec
{
121 const __DRIconfig
**(*InitScreen
) (__DRIscreen
* priv
);
123 void (*DestroyScreen
)(__DRIscreen
*driScrnPriv
);
125 GLboolean (*CreateContext
)(gl_api api
,
126 const struct gl_config
*glVis
,
127 __DRIcontext
*driContextPriv
,
128 const struct __DriverContextConfig
*ctx_config
,
130 void *sharedContextPrivate
);
132 void (*DestroyContext
)(__DRIcontext
*driContextPriv
);
134 GLboolean (*CreateBuffer
)(__DRIscreen
*driScrnPriv
,
135 __DRIdrawable
*driDrawPriv
,
136 const struct gl_config
*glVis
,
137 GLboolean pixmapBuffer
);
139 void (*DestroyBuffer
)(__DRIdrawable
*driDrawPriv
);
141 void (*SwapBuffers
)(__DRIdrawable
*driDrawPriv
);
143 GLboolean (*MakeCurrent
)(__DRIcontext
*driContextPriv
,
144 __DRIdrawable
*driDrawPriv
,
145 __DRIdrawable
*driReadPriv
);
147 GLboolean (*UnbindContext
)(__DRIcontext
*driContextPriv
);
149 __DRIbuffer
*(*AllocateBuffer
) (__DRIscreen
*screenPrivate
,
150 unsigned int attachment
,
152 int width
, int height
);
154 void (*ReleaseBuffer
) (__DRIscreen
*screenPrivate
, __DRIbuffer
*buffer
);
156 void (*CopySubBuffer
)(__DRIdrawable
*driDrawPriv
, int x
, int y
,
160 extern const struct __DriverAPIRec driDriverAPI
;
161 extern const struct __DriverAPIRec
*globalDriverAPI
;
164 * Per-screen private driver information.
166 struct __DRIscreenRec
{
168 * Driver-specific entrypoints provided by the driver's
169 * __DRIDriverVtableExtensionRec.
171 const struct __DriverAPIRec
*driver
;
174 * Current screen's number
179 * File descriptor returned when the kernel device driver is opened.
182 * - authenticate client to kernel
183 * - map the frame buffer, SAREA, etc.
184 * - close the kernel device driver
189 * Device-dependent private information (not stored in the SAREA).
191 * This pointer is never touched by the DRI layer.
197 int max_gl_core_version
;
198 int max_gl_compat_version
;
199 int max_gl_es1_version
;
200 int max_gl_es2_version
;
202 const __DRIextension
**extensions
;
204 const __DRIswrastLoaderExtension
*swrast_loader
;
207 /* Flag to indicate that this is a DRI2 screen. Many of the above
208 * fields will not be valid or initializaed in that case. */
209 const __DRIdri2LoaderExtension
*loader
;
210 const __DRIimageLookupExtension
*image
;
211 const __DRIuseInvalidateExtension
*useInvalidate
;
212 const __DRIbackgroundCallableExtension
*backgroundCallable
;
216 const __DRIimageLoaderExtension
*loader
;
220 const __DRImutableRenderBufferLoaderExtension
*loader
;
221 } mutableRenderBuffer
;
223 driOptionCache optionInfo
;
224 driOptionCache optionCache
;
226 unsigned int api_mask
;
230 * Per-context private driver information.
232 struct __DRIcontextRec
{
234 * Device driver's private context data. This structure is opaque.
239 * The loaders's private context data. This structure is opaque.
244 * Pointer to drawable currently bound to this context for drawing.
246 __DRIdrawable
*driDrawablePriv
;
249 * Pointer to drawable currently bound to this context for reading.
251 __DRIdrawable
*driReadablePriv
;
254 * Pointer to screen on which this context was created.
256 __DRIscreen
*driScreenPriv
;
265 * Per-drawable private DRI driver information.
267 struct __DRIdrawableRec
{
269 * Driver's private drawable information.
271 * This structure is opaque.
276 * Private data from the loader. We just hold on to it and pass
277 * it back when calling into loader provided functions.
282 * Pointer to context to which this drawable is currently bound.
284 __DRIcontext
*driContextPriv
;
287 * Pointer to screen on which this drawable was created.
289 __DRIscreen
*driScreenPriv
;
292 * Reference count for number of context's currently bound to this
295 * Once it reaches zero, the drawable can be destroyed.
297 * \note This behavior will change with GLX 1.3.
302 * Last value of the stamp.
304 * If this differs from the value stored at __DRIdrawable::dri2.stamp,
305 * then the drawable information has been modified by the X server, and the
306 * drawable information (below) should be retrieved from the X server.
308 unsigned int lastStamp
;
313 * Drawable timestamp. Increased when the loader calls invalidate.
321 driGLFormatToImageFormat(mesa_format format
);
324 driImageFormatToGLFormat(uint32_t image_format
);
327 dri2InvalidateDrawable(__DRIdrawable
*drawable
);
330 driUpdateFramebufferSize(struct gl_context
*ctx
, const __DRIdrawable
*dPriv
);
333 driContextSetFlags(struct gl_context
*ctx
, uint32_t flags
);
335 extern const __DRIimageDriverExtension driImageDriverExtension
;
337 extern const __DRInoErrorExtension dri2NoErrorExtension
;
339 #endif /* _DRI_UTIL_H_ */