2 * Mesa 3-D graphics library
4 * Copyright 2016 Advanced Micro Devices, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
25 /* Mesa OpenGL inter-driver interoperability interface designed for but not
28 * This is a driver-agnostic, backward-compatible interface. The structures
29 * are only allowed to grow. They can never shrink and their members can
30 * never be removed, renamed, or redefined.
32 * The interface doesn't return a lot of static texture parameters like
33 * width, height, etc. It mainly returns mutable buffer and texture view
34 * parameters that can't be part of the texture allocation (because they are
35 * mutable). If drivers want to return more data or want to return static
36 * allocation parameters, they can do it in one of these two ways:
37 * - attaching the data to the DMABUF handle in a driver-specific way
38 * - passing the data via "out_driver_data" in the "in" structure.
40 * Mesa is expected to do a lot of error checking on behalf of OpenCL, such
41 * as checking the target, miplevel, and texture completeness.
43 * OpenCL, on the other hand, needs to check if the display+context combo
44 * is compatible with the OpenCL driver by querying the device information.
45 * It also needs to check if the texture internal format and channel ordering
46 * (returned in a driver-specific way) is supported by OpenCL, among other
50 #ifndef MESA_GLINTEROP_H
51 #define MESA_GLINTEROP_H
60 /* Forward declarations to avoid inclusion of GL/glx.h */
62 struct __GLXcontextRec
;
64 /* Forward declarations to avoid inclusion of EGL/egl.h */
65 typedef void *EGLDisplay
;
66 typedef void *EGLContext
;
68 /** Returned error codes. */
70 MESA_GLINTEROP_SUCCESS
= 0,
71 MESA_GLINTEROP_OUT_OF_RESOURCES
,
72 MESA_GLINTEROP_OUT_OF_HOST_MEMORY
,
73 MESA_GLINTEROP_INVALID_OPERATION
,
74 MESA_GLINTEROP_INVALID_VERSION
,
75 MESA_GLINTEROP_INVALID_DISPLAY
,
76 MESA_GLINTEROP_INVALID_CONTEXT
,
77 MESA_GLINTEROP_INVALID_TARGET
,
78 MESA_GLINTEROP_INVALID_OBJECT
,
79 MESA_GLINTEROP_INVALID_MIP_LEVEL
,
80 MESA_GLINTEROP_UNSUPPORTED
85 MESA_GLINTEROP_ACCESS_READ_WRITE
= 0,
86 MESA_GLINTEROP_ACCESS_READ_ONLY
,
87 MESA_GLINTEROP_ACCESS_WRITE_ONLY
90 #define MESA_GLINTEROP_DEVICE_INFO_VERSION 1
93 * Device information returned by Mesa.
95 struct mesa_glinterop_device_info
{
96 /* The caller should set this to the version of the struct they support */
97 /* The callee will overwrite it if it supports a lower version.
99 * The caller should check the value and access up-to the version supported
102 /* NOTE: Do not use the MESA_GLINTEROP_DEVICE_INFO_VERSION macro */
106 uint32_t pci_segment_group
;
109 uint32_t pci_function
;
111 /* Device identification */
115 /* Structure version 1 ends here. */
118 #define MESA_GLINTEROP_EXPORT_IN_VERSION 1
121 * Input parameters to Mesa interop export functions.
123 struct mesa_glinterop_export_in
{
124 /* The caller should set this to the version of the struct they support */
125 /* The callee will overwrite it if it supports a lower version.
127 * The caller should check the value and access up-to the version supported
130 /* NOTE: Do not use the MESA_GLINTEROP_EXPORT_IN_VERSION macro */
133 /* One of the following:
134 * - GL_TEXTURE_BUFFER
138 * - GL_TEXTURE_RECTANGLE
139 * - GL_TEXTURE_1D_ARRAY
140 * - GL_TEXTURE_2D_ARRAY
141 * - GL_TEXTURE_CUBE_MAP_ARRAY
142 * - GL_TEXTURE_CUBE_MAP
143 * - GL_TEXTURE_CUBE_MAP_POSITIVE_X
144 * - GL_TEXTURE_CUBE_MAP_NEGATIVE_X
145 * - GL_TEXTURE_CUBE_MAP_POSITIVE_Y
146 * - GL_TEXTURE_CUBE_MAP_NEGATIVE_Y
147 * - GL_TEXTURE_CUBE_MAP_POSITIVE_Z
148 * - GL_TEXTURE_CUBE_MAP_NEGATIVE_Z
149 * - GL_TEXTURE_2D_MULTISAMPLE
150 * - GL_TEXTURE_2D_MULTISAMPLE_ARRAY
151 * - GL_TEXTURE_EXTERNAL_OES
157 /* If target is GL_ARRAY_BUFFER, it's a buffer object.
158 * If target is GL_RENDERBUFFER, it's a renderbuffer object.
159 * If target is GL_TEXTURE_*, it's a texture object.
163 /* Mipmap level. Ignored for non-texture objects. */
166 /* One of MESA_GLINTEROP_ACCESS_* flags. This describes how the exported
167 * object is going to be used.
171 /* Size of memory pointed to by out_driver_data. */
172 uint32_t out_driver_data_size
;
174 /* If the caller wants to query driver-specific data about the OpenGL
175 * object, this should point to the memory where that data will be stored.
176 * This is expected to be a temporary staging memory. The pointer is not
177 * allowed to be saved for later use by Mesa.
179 void *out_driver_data
;
180 /* Structure version 1 ends here. */
183 #define MESA_GLINTEROP_EXPORT_OUT_VERSION 1
186 * Outputs of Mesa interop export functions.
188 struct mesa_glinterop_export_out
{
189 /* The caller should set this to the version of the struct they support */
190 /* The callee will overwrite it if it supports a lower version.
192 * The caller should check the value and access up-to the version supported
195 /* NOTE: Do not use the MESA_GLINTEROP_EXPORT_OUT_VERSION macro */
198 /* The DMABUF handle. It must be closed by the caller using the POSIX
199 * close() function when it's not needed anymore. Mesa is not responsible
200 * for closing the handle.
202 * Not closing the handle by the caller will lead to a resource leak,
203 * will prevent releasing the GPU buffer, and may prevent creating new
204 * DMABUF handles within the process.
208 /* The mutable OpenGL internal format specified by glTextureView or
209 * glTexBuffer. If the object is not one of those, the original internal
210 * format specified by glTexStorage, glTexImage, or glRenderbufferStorage
213 unsigned internal_format
;
215 /* Buffer offset and size for GL_ARRAY_BUFFER and GL_TEXTURE_BUFFER.
216 * This allows interop with suballocations (a buffer allocated within
219 * Parameters specified by glTexBufferRange for GL_TEXTURE_BUFFER are
220 * applied to these and can shrink the range further.
222 ptrdiff_t buf_offset
;
225 /* Parameters specified by glTextureView. If the object is not a texture
226 * view, default parameters covering the whole texture will be returned.
228 unsigned view_minlevel
;
229 unsigned view_numlevels
;
230 unsigned view_minlayer
;
231 unsigned view_numlayers
;
233 /* The number of bytes written to out_driver_data. */
234 uint32_t out_driver_data_written
;
235 /* Structure version 1 ends here. */
240 * Query device information.
242 * \param dpy GLX display
243 * \param context GLX context
244 * \param out where to return the information
246 * \return MESA_GLINTEROP_SUCCESS or MESA_GLINTEROP_* != 0 on error
249 MesaGLInteropGLXQueryDeviceInfo(struct _XDisplay
*dpy
, struct __GLXcontextRec
*context
,
250 struct mesa_glinterop_device_info
*out
);
254 * Same as MesaGLInteropGLXQueryDeviceInfo except that it accepts EGLDisplay
258 MesaGLInteropEGLQueryDeviceInfo(EGLDisplay dpy
, EGLContext context
,
259 struct mesa_glinterop_device_info
*out
);
263 * Create and return a DMABUF handle corresponding to the given OpenGL
264 * object, and return other parameters about the OpenGL object.
266 * \param dpy GLX display
267 * \param context GLX context
268 * \param in input parameters
269 * \param out return values
271 * \return MESA_GLINTEROP_SUCCESS or MESA_GLINTEROP_* != 0 on error
274 MesaGLInteropGLXExportObject(struct _XDisplay
*dpy
, struct __GLXcontextRec
*context
,
275 struct mesa_glinterop_export_in
*in
,
276 struct mesa_glinterop_export_out
*out
);
280 * Same as MesaGLInteropGLXExportObject except that it accepts
281 * EGLDisplay and EGLContext.
284 MesaGLInteropEGLExportObject(EGLDisplay dpy
, EGLContext context
,
285 struct mesa_glinterop_export_in
*in
,
286 struct mesa_glinterop_export_out
*out
);
289 typedef int (PFNMESAGLINTEROPGLXQUERYDEVICEINFOPROC
)(struct _XDisplay
*dpy
, struct __GLXcontextRec
*context
,
290 struct mesa_glinterop_device_info
*out
);
291 typedef int (PFNMESAGLINTEROPEGLQUERYDEVICEINFOPROC
)(EGLDisplay dpy
, EGLContext context
,
292 struct mesa_glinterop_device_info
*out
);
293 typedef int (PFNMESAGLINTEROPGLXEXPORTOBJECTPROC
)(struct _XDisplay
*dpy
, struct __GLXcontextRec
*context
,
294 struct mesa_glinterop_export_in
*in
,
295 struct mesa_glinterop_export_out
*out
);
296 typedef int (PFNMESAGLINTEROPEGLEXPORTOBJECTPROC
)(EGLDisplay dpy
, EGLContext context
,
297 struct mesa_glinterop_export_in
*in
,
298 struct mesa_glinterop_export_out
*out
);
304 #endif /* MESA_GLINTEROP_H */