Sheri Zhang | 79cb945 | 2021-09-07 14:51:49 +0100 | [diff] [blame] | 1 | /******************************************************************************* |
Pablo Marquez Tello | dc2282f | 2021-11-23 15:16:00 +0000 | [diff] [blame] | 2 | * Copyright (c) 2008-2021 The Khronos Group Inc. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 3 | * |
Sheri Zhang | 79cb945 | 2021-09-07 14:51:49 +0100 | [diff] [blame] | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 7 | * |
Sheri Zhang | 79cb945 | 2021-09-07 14:51:49 +0100 | [diff] [blame] | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 9 | * |
Sheri Zhang | 79cb945 | 2021-09-07 14:51:49 +0100 | [diff] [blame] | 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | ******************************************************************************/ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 16 | |
| 17 | #ifndef __OPENCL_CL_GL_H |
| 18 | #define __OPENCL_CL_GL_H |
| 19 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 20 | #include <CL/cl.h> |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 21 | |
| 22 | #ifdef __cplusplus |
| 23 | extern "C" { |
| 24 | #endif |
| 25 | |
| 26 | typedef cl_uint cl_gl_object_type; |
| 27 | typedef cl_uint cl_gl_texture_info; |
| 28 | typedef cl_uint cl_gl_platform_info; |
| 29 | typedef struct __GLsync *cl_GLsync; |
| 30 | |
| 31 | /* cl_gl_object_type = 0x2000 - 0x200F enum values are currently taken */ |
| 32 | #define CL_GL_OBJECT_BUFFER 0x2000 |
| 33 | #define CL_GL_OBJECT_TEXTURE2D 0x2001 |
| 34 | #define CL_GL_OBJECT_TEXTURE3D 0x2002 |
| 35 | #define CL_GL_OBJECT_RENDERBUFFER 0x2003 |
Anthony Barbier | 8b2fdc9 | 2018-08-09 11:42:38 +0100 | [diff] [blame] | 36 | #ifdef CL_VERSION_1_2 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 37 | #define CL_GL_OBJECT_TEXTURE2D_ARRAY 0x200E |
| 38 | #define CL_GL_OBJECT_TEXTURE1D 0x200F |
| 39 | #define CL_GL_OBJECT_TEXTURE1D_ARRAY 0x2010 |
| 40 | #define CL_GL_OBJECT_TEXTURE_BUFFER 0x2011 |
Anthony Barbier | 8b2fdc9 | 2018-08-09 11:42:38 +0100 | [diff] [blame] | 41 | #endif |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 42 | |
| 43 | /* cl_gl_texture_info */ |
| 44 | #define CL_GL_TEXTURE_TARGET 0x2004 |
| 45 | #define CL_GL_MIPMAP_LEVEL 0x2005 |
Anthony Barbier | 8b2fdc9 | 2018-08-09 11:42:38 +0100 | [diff] [blame] | 46 | #ifdef CL_VERSION_1_2 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 47 | #define CL_GL_NUM_SAMPLES 0x2012 |
Anthony Barbier | 8b2fdc9 | 2018-08-09 11:42:38 +0100 | [diff] [blame] | 48 | #endif |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 49 | |
| 50 | |
| 51 | extern CL_API_ENTRY cl_mem CL_API_CALL |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 52 | clCreateFromGLBuffer(cl_context context, |
| 53 | cl_mem_flags flags, |
| 54 | cl_GLuint bufobj, |
| 55 | cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_0; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 56 | |
Anthony Barbier | 8b2fdc9 | 2018-08-09 11:42:38 +0100 | [diff] [blame] | 57 | #ifdef CL_VERSION_1_2 |
| 58 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 59 | extern CL_API_ENTRY cl_mem CL_API_CALL |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 60 | clCreateFromGLTexture(cl_context context, |
| 61 | cl_mem_flags flags, |
| 62 | cl_GLenum target, |
| 63 | cl_GLint miplevel, |
| 64 | cl_GLuint texture, |
| 65 | cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_2; |
| 66 | |
Anthony Barbier | 8b2fdc9 | 2018-08-09 11:42:38 +0100 | [diff] [blame] | 67 | #endif |
| 68 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 69 | extern CL_API_ENTRY cl_mem CL_API_CALL |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 70 | clCreateFromGLRenderbuffer(cl_context context, |
| 71 | cl_mem_flags flags, |
| 72 | cl_GLuint renderbuffer, |
| 73 | cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_0; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 74 | |
| 75 | extern CL_API_ENTRY cl_int CL_API_CALL |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 76 | clGetGLObjectInfo(cl_mem memobj, |
| 77 | cl_gl_object_type * gl_object_type, |
| 78 | cl_GLuint * gl_object_name) CL_API_SUFFIX__VERSION_1_0; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 79 | |
| 80 | extern CL_API_ENTRY cl_int CL_API_CALL |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 81 | clGetGLTextureInfo(cl_mem memobj, |
| 82 | cl_gl_texture_info param_name, |
| 83 | size_t param_value_size, |
| 84 | void * param_value, |
| 85 | size_t * param_value_size_ret) CL_API_SUFFIX__VERSION_1_0; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 86 | |
| 87 | extern CL_API_ENTRY cl_int CL_API_CALL |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 88 | clEnqueueAcquireGLObjects(cl_command_queue command_queue, |
| 89 | cl_uint num_objects, |
| 90 | const cl_mem * mem_objects, |
| 91 | cl_uint num_events_in_wait_list, |
| 92 | const cl_event * event_wait_list, |
| 93 | cl_event * event) CL_API_SUFFIX__VERSION_1_0; |
| 94 | |
| 95 | extern CL_API_ENTRY cl_int CL_API_CALL |
| 96 | clEnqueueReleaseGLObjects(cl_command_queue command_queue, |
| 97 | cl_uint num_objects, |
| 98 | const cl_mem * mem_objects, |
| 99 | cl_uint num_events_in_wait_list, |
| 100 | const cl_event * event_wait_list, |
| 101 | cl_event * event) CL_API_SUFFIX__VERSION_1_0; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 102 | |
| 103 | |
Pablo Tello | e86a09f | 2018-01-11 15:44:48 +0000 | [diff] [blame] | 104 | /* Deprecated OpenCL 1.1 APIs */ |
Pablo Marquez Tello | dc2282f | 2021-11-23 15:16:00 +0000 | [diff] [blame] | 105 | extern CL_API_ENTRY CL_API_PREFIX__VERSION_1_1_DEPRECATED cl_mem CL_API_CALL |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 106 | clCreateFromGLTexture2D(cl_context context, |
| 107 | cl_mem_flags flags, |
| 108 | cl_GLenum target, |
| 109 | cl_GLint miplevel, |
| 110 | cl_GLuint texture, |
Pablo Marquez Tello | dc2282f | 2021-11-23 15:16:00 +0000 | [diff] [blame] | 111 | cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_1_DEPRECATED; |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 112 | |
Pablo Marquez Tello | dc2282f | 2021-11-23 15:16:00 +0000 | [diff] [blame] | 113 | extern CL_API_ENTRY CL_API_PREFIX__VERSION_1_1_DEPRECATED cl_mem CL_API_CALL |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 114 | clCreateFromGLTexture3D(cl_context context, |
| 115 | cl_mem_flags flags, |
| 116 | cl_GLenum target, |
| 117 | cl_GLint miplevel, |
| 118 | cl_GLuint texture, |
Pablo Marquez Tello | dc2282f | 2021-11-23 15:16:00 +0000 | [diff] [blame] | 119 | cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_1_DEPRECATED; |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 120 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 121 | /* cl_khr_gl_sharing extension */ |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 122 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 123 | #define cl_khr_gl_sharing 1 |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 124 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 125 | typedef cl_uint cl_gl_context_info; |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 126 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 127 | /* Additional Error Codes */ |
| 128 | #define CL_INVALID_GL_SHAREGROUP_REFERENCE_KHR -1000 |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 129 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 130 | /* cl_gl_context_info */ |
| 131 | #define CL_CURRENT_DEVICE_FOR_GL_CONTEXT_KHR 0x2006 |
| 132 | #define CL_DEVICES_FOR_GL_CONTEXT_KHR 0x2007 |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 133 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 134 | /* Additional cl_context_properties */ |
| 135 | #define CL_GL_CONTEXT_KHR 0x2008 |
| 136 | #define CL_EGL_DISPLAY_KHR 0x2009 |
| 137 | #define CL_GLX_DISPLAY_KHR 0x200A |
| 138 | #define CL_WGL_HDC_KHR 0x200B |
| 139 | #define CL_CGL_SHAREGROUP_KHR 0x200C |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 140 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 141 | extern CL_API_ENTRY cl_int CL_API_CALL |
Sheri Zhang | 67354e0 | 2021-06-30 16:08:29 +0100 | [diff] [blame] | 142 | clGetGLContextInfoKHR(const cl_context_properties * properties, |
| 143 | cl_gl_context_info param_name, |
| 144 | size_t param_value_size, |
| 145 | void * param_value, |
| 146 | size_t * param_value_size_ret) CL_API_SUFFIX__VERSION_1_0; |
| 147 | |
Pablo Marquez Tello | dc2282f | 2021-11-23 15:16:00 +0000 | [diff] [blame] | 148 | typedef cl_int (CL_API_CALL *clGetGLContextInfoKHR_fn)( |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 149 | const cl_context_properties * properties, |
| 150 | cl_gl_context_info param_name, |
| 151 | size_t param_value_size, |
| 152 | void * param_value, |
| 153 | size_t * param_value_size_ret); |
| 154 | |
Pablo Marquez Tello | dc2282f | 2021-11-23 15:16:00 +0000 | [diff] [blame] | 155 | /* |
| 156 | * cl_khr_gl_event extension |
| 157 | */ |
| 158 | #define CL_COMMAND_GL_FENCE_SYNC_OBJECT_KHR 0x200D |
| 159 | |
| 160 | extern CL_API_ENTRY cl_event CL_API_CALL |
| 161 | clCreateEventFromGLsyncKHR(cl_context context, |
| 162 | cl_GLsync sync, |
| 163 | cl_int * errcode_ret) CL_API_SUFFIX__VERSION_1_1; |
| 164 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 165 | #ifdef __cplusplus |
| 166 | } |
| 167 | #endif |
| 168 | |
| 169 | #endif /* __OPENCL_CL_GL_H */ |