Gitiles
Code Review Sign In
review.mlplatform.org / ml / ComputeLibrary / d051e97e36b9981f411093904cc019c2c7f9ac75 / . / include / CL / cl_gl.h
blob: 945daa83d7f712918886693b75a3f0b40bc0ad50 [file] [log] [blame]
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100[diff] [blame]1/**********************************************************************************
Pablo Telloe86a09f2018-01-11 15:44:48 +0000[diff] [blame]2 * Copyright (c) 2008-2015 The Khronos Group Inc.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100[diff] [blame]3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and/or associated documentation files (the
6 * "Materials"), to deal in the Materials without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sublicense, and/or sell copies of the Materials, and to
9 * permit persons to whom the Materials are furnished to do so, subject to
10 * the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included
13 * in all copies or substantial portions of the Materials.
14 *
Pablo Telloe86a09f2018-01-11 15:44:48 +0000[diff] [blame]15 * MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS
16 * KHRONOS STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS
17 * SPECIFICATIONS AND HEADER INFORMATION ARE LOCATED AT
18 * https://www.khronos.org/registry/
19 *
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100[diff] [blame]20 * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
24 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26 * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
27 **********************************************************************************/
28
29#ifndef __OPENCL_CL_GL_H
30#define __OPENCL_CL_GL_H
31
32#ifdef __APPLE__
33#include <OpenCL/cl.h>
34#else
35#include <CL/cl.h>
36#endif
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
42typedef cl_uint cl_gl_object_type;
43typedef cl_uint cl_gl_texture_info;
44typedef cl_uint cl_gl_platform_info;
45typedef struct __GLsync *cl_GLsync;
46
47/* cl_gl_object_type = 0x2000 - 0x200F enum values are currently taken */
48#define CL_GL_OBJECT_BUFFER 0x2000
49#define CL_GL_OBJECT_TEXTURE2D 0x2001
50#define CL_GL_OBJECT_TEXTURE3D 0x2002
51#define CL_GL_OBJECT_RENDERBUFFER 0x2003
52#define CL_GL_OBJECT_TEXTURE2D_ARRAY 0x200E
53#define CL_GL_OBJECT_TEXTURE1D 0x200F
54#define CL_GL_OBJECT_TEXTURE1D_ARRAY 0x2010
55#define CL_GL_OBJECT_TEXTURE_BUFFER 0x2011
56
57/* cl_gl_texture_info */
58#define CL_GL_TEXTURE_TARGET 0x2004
59#define CL_GL_MIPMAP_LEVEL 0x2005
60#define CL_GL_NUM_SAMPLES 0x2012
61
62
63extern CL_API_ENTRY cl_mem CL_API_CALL
64clCreateFromGLBuffer(cl_context /* context */,
65 cl_mem_flags /* flags */,
66 cl_GLuint /* bufobj */,
67 int * /* errcode_ret */) CL_API_SUFFIX__VERSION_1_0;
68
69extern CL_API_ENTRY cl_mem CL_API_CALL
70clCreateFromGLTexture(cl_context /* context */,
71 cl_mem_flags /* flags */,
72 cl_GLenum /* target */,
73 cl_GLint /* miplevel */,
74 cl_GLuint /* texture */,
75 cl_int * /* errcode_ret */) CL_API_SUFFIX__VERSION_1_2;
76
77extern CL_API_ENTRY cl_mem CL_API_CALL
78clCreateFromGLRenderbuffer(cl_context /* context */,
79 cl_mem_flags /* flags */,
80 cl_GLuint /* renderbuffer */,
81 cl_int * /* errcode_ret */) CL_API_SUFFIX__VERSION_1_0;
82
83extern CL_API_ENTRY cl_int CL_API_CALL
84clGetGLObjectInfo(cl_mem /* memobj */,
85 cl_gl_object_type * /* gl_object_type */,
86 cl_GLuint * /* gl_object_name */) CL_API_SUFFIX__VERSION_1_0;
87
88extern CL_API_ENTRY cl_int CL_API_CALL
89clGetGLTextureInfo(cl_mem /* memobj */,
90 cl_gl_texture_info /* param_name */,
91 size_t /* param_value_size */,
92 void * /* param_value */,
93 size_t * /* param_value_size_ret */) CL_API_SUFFIX__VERSION_1_0;
94
95extern CL_API_ENTRY cl_int CL_API_CALL
96clEnqueueAcquireGLObjects(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;
102
103extern CL_API_ENTRY cl_int CL_API_CALL
104clEnqueueReleaseGLObjects(cl_command_queue /* command_queue */,
105 cl_uint /* num_objects */,
106 const cl_mem * /* mem_objects */,
107 cl_uint /* num_events_in_wait_list */,
108 const cl_event * /* event_wait_list */,
109 cl_event * /* event */) CL_API_SUFFIX__VERSION_1_0;
110
111
Pablo Telloe86a09f2018-01-11 15:44:48 +0000[diff] [blame]112/* Deprecated OpenCL 1.1 APIs */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100[diff] [blame]113extern CL_API_ENTRY CL_EXT_PREFIX__VERSION_1_1_DEPRECATED cl_mem CL_API_CALL
114clCreateFromGLTexture2D(cl_context /* context */,
115 cl_mem_flags /* flags */,
116 cl_GLenum /* target */,
117 cl_GLint /* miplevel */,
118 cl_GLuint /* texture */,
119 cl_int * /* errcode_ret */) CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED;
120
121extern CL_API_ENTRY CL_EXT_PREFIX__VERSION_1_1_DEPRECATED cl_mem CL_API_CALL
122clCreateFromGLTexture3D(cl_context /* context */,
123 cl_mem_flags /* flags */,
124 cl_GLenum /* target */,
125 cl_GLint /* miplevel */,
126 cl_GLuint /* texture */,
127 cl_int * /* errcode_ret */) CL_EXT_SUFFIX__VERSION_1_1_DEPRECATED;
128
129/* cl_khr_gl_sharing extension */
130
131#define cl_khr_gl_sharing 1
132
133typedef cl_uint cl_gl_context_info;
134
135/* Additional Error Codes */
136#define CL_INVALID_GL_SHAREGROUP_REFERENCE_KHR -1000
137
138/* cl_gl_context_info */
139#define CL_CURRENT_DEVICE_FOR_GL_CONTEXT_KHR 0x2006
140#define CL_DEVICES_FOR_GL_CONTEXT_KHR 0x2007
141
142/* Additional cl_context_properties */
143#define CL_GL_CONTEXT_KHR 0x2008
144#define CL_EGL_DISPLAY_KHR 0x2009
145#define CL_GLX_DISPLAY_KHR 0x200A
146#define CL_WGL_HDC_KHR 0x200B
147#define CL_CGL_SHAREGROUP_KHR 0x200C
148
149extern CL_API_ENTRY cl_int CL_API_CALL
150clGetGLContextInfoKHR(const cl_context_properties * /* properties */,
151 cl_gl_context_info /* param_name */,
152 size_t /* param_value_size */,
153 void * /* param_value */,
154 size_t * /* param_value_size_ret */) CL_API_SUFFIX__VERSION_1_0;
155
156typedef CL_API_ENTRY cl_int (CL_API_CALL *clGetGLContextInfoKHR_fn)(
157 const cl_context_properties * properties,
158 cl_gl_context_info param_name,
159 size_t param_value_size,
160 void * param_value,
161 size_t * param_value_size_ret);
162
163#ifdef __cplusplus
164}
165#endif
166
167#endif /* __OPENCL_CL_GL_H */