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 */
61 typedef struct _XDisplay Display
;
62 typedef struct __GLXcontextRec
*GLXContext
;
64 /** Returned error codes. */
66 MESA_GLINTEROP_SUCCESS
= 0,
67 MESA_GLINTEROP_OUT_OF_RESOURCES
,
68 MESA_GLINTEROP_OUT_OF_HOST_MEMORY
,
69 MESA_GLINTEROP_INVALID_OPERATION
,
70 MESA_GLINTEROP_INVALID_VALUE
,
71 MESA_GLINTEROP_INVALID_DISPLAY
,
72 MESA_GLINTEROP_INVALID_CONTEXT
,
73 MESA_GLINTEROP_INVALID_TARGET
,
74 MESA_GLINTEROP_INVALID_OBJECT
,
75 MESA_GLINTEROP_INVALID_MIP_LEVEL
,
76 MESA_GLINTEROP_UNSUPPORTED
81 MESA_GLINTEROP_ACCESS_READ_WRITE
= 0,
82 MESA_GLINTEROP_ACCESS_READ_ONLY
,
83 MESA_GLINTEROP_ACCESS_WRITE_ONLY
86 #define MESA_GLINTEROP_DEVICE_INFO_VERSION 1
89 * Device information returned by Mesa.
91 typedef struct _mesa_glinterop_device_info
{
92 /* The caller should set this to: MESA_GLINTEROP_DEVICE_INFO_VERSION */
93 uint32_t struct_version
;
96 uint32_t pci_segment_group
;
99 uint32_t pci_function
;
101 /* Device identification */
105 /* The interop version determines what behavior the caller should expect
106 * out of all functions.
109 * - mesa_glinterop_export_in is not read beyond "out_driver_data"
110 * - mesa_glinterop_export_out is not written beyond "out_driver_data_written"
111 * - mesa_glinterop_device_info is not written beyond "interop_version"
113 uint32_t interop_version
;
114 /* Structure version 1 ends here. */
115 } mesa_glinterop_device_info
;
117 #define MESA_GLINTEROP_EXPORT_IN_VERSION 1
120 * Input parameters to Mesa interop export functions.
122 typedef struct _mesa_glinterop_export_in
{
123 /* The caller should set this to: MESA_GLINTEROP_EXPORT_IN_VERSION */
124 uint32_t struct_version
;
126 /* One of the following:
127 * - GL_TEXTURE_BUFFER
131 * - GL_TEXTURE_RECTANGLE
132 * - GL_TEXTURE_1D_ARRAY
133 * - GL_TEXTURE_2D_ARRAY
134 * - GL_TEXTURE_CUBE_MAP_ARRAY
135 * - GL_TEXTURE_CUBE_MAP
136 * - GL_TEXTURE_CUBE_MAP_POSITIVE_X
137 * - GL_TEXTURE_CUBE_MAP_NEGATIVE_X
138 * - GL_TEXTURE_CUBE_MAP_POSITIVE_Y
139 * - GL_TEXTURE_CUBE_MAP_NEGATIVE_Y
140 * - GL_TEXTURE_CUBE_MAP_POSITIVE_Z
141 * - GL_TEXTURE_CUBE_MAP_NEGATIVE_Z
142 * - GL_TEXTURE_2D_MULTISAMPLE
143 * - GL_TEXTURE_2D_MULTISAMPLE_ARRAY
144 * - GL_TEXTURE_EXTERNAL_OES
150 /* If target is GL_ARRAY_BUFFER, it's a buffer object.
151 * If target is GL_RENDERBUFFER, it's a renderbuffer object.
152 * If target is GL_TEXTURE_*, it's a texture object.
156 /* Mipmap level. Ignored for non-texture objects. */
159 /* One of MESA_GLINTEROP_ACCESS_* flags. This describes how the exported
160 * object is going to be used.
164 /* Size of memory pointed to by out_driver_data. */
165 uint32_t out_driver_data_size
;
167 /* If the caller wants to query driver-specific data about the OpenGL
168 * object, this should point to the memory where that data will be stored.
169 * This is expected to be a temporary staging memory. The pointer is not
170 * allowed to be saved for later use by Mesa.
172 void *out_driver_data
;
173 /* Structure version 1 ends here. */
174 } mesa_glinterop_export_in
;
176 #define MESA_GLINTEROP_EXPORT_OUT_VERSION 1
179 * Outputs of Mesa interop export functions.
181 typedef struct _mesa_glinterop_export_out
{
182 /* The caller should set this to: MESA_GLINTEROP_EXPORT_OUT_VERSION */
183 uint32_t struct_version
;
185 /* The DMABUF handle. It must be closed by the caller using the POSIX
186 * close() function when it's not needed anymore. Mesa is not responsible
187 * for closing the handle.
189 * Not closing the handle by the caller will lead to a resource leak,
190 * will prevent releasing the GPU buffer, and may prevent creating new
191 * DMABUF handles within the process.
195 /* The mutable OpenGL internal format specified by glTextureView or
196 * glTexBuffer. If the object is not one of those, the original internal
197 * format specified by glTexStorage, glTexImage, or glRenderbufferStorage
200 unsigned internal_format
;
202 /* Buffer offset and size for GL_ARRAY_BUFFER and GL_TEXTURE_BUFFER.
203 * This allows interop with suballocations (a buffer allocated within
206 * Parameters specified by glTexBufferRange for GL_TEXTURE_BUFFER are
207 * applied to these and can shrink the range further.
209 ptrdiff_t buf_offset
;
212 /* Parameters specified by glTextureView. If the object is not a texture
213 * view, default parameters covering the whole texture will be returned.
215 unsigned view_minlevel
;
216 unsigned view_numlevels
;
217 unsigned view_minlayer
;
218 unsigned view_numlayers
;
220 /* The number of bytes written to out_driver_data. */
221 uint32_t out_driver_data_written
;
222 /* Structure version 1 ends here. */
223 } mesa_glinterop_export_out
;
227 * Query device information.
229 * \param dpy GLX display
230 * \param context GLX context
231 * \param out where to return the information
233 * \return MESA_GLINTEROP_SUCCESS or MESA_GLINTEROP_* != 0 on error
236 MesaGLInteropGLXQueryDeviceInfo(Display
*dpy
, GLXContext context
,
237 mesa_glinterop_device_info
*out
);
241 * Same as MesaGLInteropGLXQueryDeviceInfo except that it accepts EGLDisplay
245 MesaGLInteropEGLQueryDeviceInfo(EGLDisplay dpy
, EGLContext context
,
246 mesa_glinterop_device_info
*out
);
250 * Create and return a DMABUF handle corresponding to the given OpenGL
251 * object, and return other parameters about the OpenGL object.
253 * \param dpy GLX display
254 * \param context GLX context
255 * \param in input parameters
256 * \param out return values
258 * \return MESA_GLINTEROP_SUCCESS or MESA_GLINTEROP_* != 0 on error
261 MesaGLInteropGLXExportObject(Display
*dpy
, GLXContext context
,
262 const mesa_glinterop_export_in
*in
,
263 mesa_glinterop_export_out
*out
);
267 * Same as MesaGLInteropGLXExportObject except that it accepts
268 * EGLDisplay and EGLContext.
271 MesaGLInteropEGLExportObject(EGLDisplay dpy
, EGLContext context
,
272 const mesa_glinterop_export_in
*in
,
273 mesa_glinterop_export_out
*out
);
276 typedef int (PFNMESAGLINTEROPGLXQUERYDEVICEINFOPROC
)(Display
*dpy
, GLXContext context
,
277 mesa_glinterop_device_info
*out
);
278 typedef int (PFNMESAGLINTEROPEGLQUERYDEVICEINFOPROC
)(EGLDisplay dpy
, EGLContext context
,
279 mesa_glinterop_device_info
*out
);
280 typedef int (PFNMESAGLINTEROPGLXEXPORTOBJECTPROC
)(Display
*dpy
, GLXContext context
,
281 const mesa_glinterop_export_in
*in
,
282 mesa_glinterop_export_out
*out
);
283 typedef int (PFNMESAGLINTEROPEGLEXPORTOBJECTPROC
)(EGLDisplay dpy
, EGLContext context
,
284 const mesa_glinterop_export_in
*in
,
285 mesa_glinterop_export_out
*out
);
291 #endif /* MESA_GLINTEROP_H */