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/mtypes.h"
59 #include "util/xmlconfig.h"
65 extern const __DRIcoreExtension driCoreExtension
;
66 extern const __DRIswrastExtension driSWRastExtension
;
67 extern const __DRIdri2Extension driDRI2Extension
;
68 extern const __DRI2configQueryExtension dri2ConfigQueryExtension
;
69 extern const __DRIcopySubBufferExtension driCopySubBufferExtension
;
70 extern const __DRI2flushControlExtension dri2FlushControlExtension
;
73 * Description of the attributes used to create a config.
75 * This is passed as the context_config parameter to CreateContext. The idea
76 * with this struct is that it can be extended without having to modify all of
77 * the drivers. The first three members (major/minor_version and flags) are
78 * always valid, but the remaining members are only valid if the corresponding
79 * flag is set for the attribute. If the flag is not set then the default
80 * value should be assumed. That way the driver can quickly check if any
81 * attributes were set that it doesn't understand and report an error.
83 struct __DriverContextConfig
{
84 /* These members are always valid */
85 unsigned major_version
;
86 unsigned minor_version
;
89 /* Flags describing which of the remaining members are valid */
90 uint32_t attribute_mask
;
92 /* Only valid if __DRIVER_CONTEXT_ATTRIB_RESET_STRATEGY is set */
95 /* Only valid if __DRIVER_CONTEXT_PRIORITY is set */
98 /* Only valid if __DRIVER_CONTEXT_ATTRIB_RELEASE_BEHAVIOR is set */
102 #define __DRIVER_CONTEXT_ATTRIB_RESET_STRATEGY (1 << 0)
103 #define __DRIVER_CONTEXT_ATTRIB_PRIORITY (1 << 1)
104 #define __DRIVER_CONTEXT_ATTRIB_RELEASE_BEHAVIOR (1 << 2)
107 * Driver callback functions.
109 * Each DRI driver must have one of these structures with all the pointers set
110 * to appropriate functions within the driver.
112 * When glXCreateContext() is called, for example, it'll call a helper function
113 * dri_util.c which in turn will jump through the \a CreateContext pointer in
116 struct __DriverAPIRec
{
117 const __DRIconfig
**(*InitScreen
) (__DRIscreen
* priv
);
119 void (*DestroyScreen
)(__DRIscreen
*driScrnPriv
);
121 GLboolean (*CreateContext
)(gl_api api
,
122 const struct gl_config
*glVis
,
123 __DRIcontext
*driContextPriv
,
124 const struct __DriverContextConfig
*ctx_config
,
126 void *sharedContextPrivate
);
128 void (*DestroyContext
)(__DRIcontext
*driContextPriv
);
130 GLboolean (*CreateBuffer
)(__DRIscreen
*driScrnPriv
,
131 __DRIdrawable
*driDrawPriv
,
132 const struct gl_config
*glVis
,
133 GLboolean pixmapBuffer
);
135 void (*DestroyBuffer
)(__DRIdrawable
*driDrawPriv
);
137 void (*SwapBuffers
)(__DRIdrawable
*driDrawPriv
);
139 GLboolean (*MakeCurrent
)(__DRIcontext
*driContextPriv
,
140 __DRIdrawable
*driDrawPriv
,
141 __DRIdrawable
*driReadPriv
);
143 GLboolean (*UnbindContext
)(__DRIcontext
*driContextPriv
);
145 __DRIbuffer
*(*AllocateBuffer
) (__DRIscreen
*screenPrivate
,
146 unsigned int attachment
,
148 int width
, int height
);
150 void (*ReleaseBuffer
) (__DRIscreen
*screenPrivate
, __DRIbuffer
*buffer
);
152 void (*CopySubBuffer
)(__DRIdrawable
*driDrawPriv
, int x
, int y
,
156 extern const struct __DriverAPIRec driDriverAPI
;
157 extern const struct __DriverAPIRec
*globalDriverAPI
;
160 * Per-screen private driver information.
162 struct __DRIscreenRec
{
164 * Driver-specific entrypoints provided by the driver's
165 * __DRIDriverVtableExtensionRec.
167 const struct __DriverAPIRec
*driver
;
170 * Current screen's number
175 * File descriptor returned when the kernel device driver is opened.
178 * - authenticate client to kernel
179 * - map the frame buffer, SAREA, etc.
180 * - close the kernel device driver
185 * Device-dependent private information (not stored in the SAREA).
187 * This pointer is never touched by the DRI layer.
193 int max_gl_core_version
;
194 int max_gl_compat_version
;
195 int max_gl_es1_version
;
196 int max_gl_es2_version
;
198 const __DRIextension
**extensions
;
200 const __DRIswrastLoaderExtension
*swrast_loader
;
203 /* Flag to indicate that this is a DRI2 screen. Many of the above
204 * fields will not be valid or initializaed in that case. */
205 const __DRIdri2LoaderExtension
*loader
;
206 const __DRIimageLookupExtension
*image
;
207 const __DRIuseInvalidateExtension
*useInvalidate
;
208 const __DRIbackgroundCallableExtension
*backgroundCallable
;
212 const __DRIimageLoaderExtension
*loader
;
215 driOptionCache optionInfo
;
216 driOptionCache optionCache
;
218 unsigned int api_mask
;
222 * Per-context private driver information.
224 struct __DRIcontextRec
{
226 * Device driver's private context data. This structure is opaque.
231 * The loaders's private context data. This structure is opaque.
236 * Pointer to drawable currently bound to this context for drawing.
238 __DRIdrawable
*driDrawablePriv
;
241 * Pointer to drawable currently bound to this context for reading.
243 __DRIdrawable
*driReadablePriv
;
246 * Pointer to screen on which this context was created.
248 __DRIscreen
*driScreenPriv
;
257 * Per-drawable private DRI driver information.
259 struct __DRIdrawableRec
{
261 * Driver's private drawable information.
263 * This structure is opaque.
268 * Private data from the loader. We just hold on to it and pass
269 * it back when calling into loader provided functions.
274 * Pointer to context to which this drawable is currently bound.
276 __DRIcontext
*driContextPriv
;
279 * Pointer to screen on which this drawable was created.
281 __DRIscreen
*driScreenPriv
;
284 * Reference count for number of context's currently bound to this
287 * Once it reaches zero, the drawable can be destroyed.
289 * \note This behavior will change with GLX 1.3.
294 * Last value of the stamp.
296 * If this differs from the value stored at __DRIdrawable::dri2.stamp,
297 * then the drawable information has been modified by the X server, and the
298 * drawable information (below) should be retrieved from the X server.
300 unsigned int lastStamp
;
305 * Drawable timestamp. Increased when the loader calls invalidate.
313 driGLFormatToImageFormat(mesa_format format
);
316 driImageFormatToGLFormat(uint32_t image_format
);
319 dri2InvalidateDrawable(__DRIdrawable
*drawable
);
322 driUpdateFramebufferSize(struct gl_context
*ctx
, const __DRIdrawable
*dPriv
);
325 driContextSetFlags(struct gl_context
*ctx
, uint32_t flags
);
327 extern const __DRIimageDriverExtension driImageDriverExtension
;
329 extern const __DRInoErrorExtension dri2NoErrorExtension
;
331 #endif /* _DRI_UTIL_H_ */