1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd" [
<!ENTITY gl_formatsInc SYSTEM "gl_formatsInc.xml">
]>
<refentry>
<refentryinfo>
<keywordset>
<keyword>clCreateFromGLRenderbuffer</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>clCreateFromGLRenderbuffer</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2011</year>
<holder>The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.</holder>
</copyright>
</refmiscinfo>
<manvolnum>3</manvolnum>
</refmeta>
<!-- ================================ SYNOPSIS -->
<refnamediv id="clCreateFromGLRenderbuffer">
<refname>clCreateFromGLRenderbuffer</refname>
<refpurpose>
Creates an OpenCL 2D image object from an OpenGL renderbuffer object.
</refpurpose>
</refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef><link xlink:href="abstractDataTypes.html">cl_mem</link>
<function>
clCreateFromGLRenderbuffer
</function>
</funcdef>
<paramdef><link xlink:href="abstractDataTypes.html">cl_context</link><parameter>context</parameter></paramdef>
<paramdef><link xlink:href="enums.html#cl_mem_flags">cl_mem_flags</link><parameter>flags</parameter></paramdef>
<paramdef>GLuint<parameter>renderbuffer</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">cl_int</link><parameter>* errcode_ret</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<term> <varname> context </varname> </term>
<listitem>
<para> <!-- parameter description -->
A valid OpenCL context created from an OpenGL context.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> flags </varname> </term>
<listitem>
<para>
<!-- parameter description --> A bit-field that is
used to specify usage information. Refer to the table at
<citerefentry><refentrytitle>clCreateBuffer</refentrytitle></citerefentry>
for a description of <varname>flags</varname>. Only
<constant>CL_MEM_READ_ONLY</constant>,
<constant>CL_MEM_WRITE_ONLY</constant>, and
<constant>CL_MEM_READ_WRITE</constant> values specified in the table at
<citerefentry><refentrytitle>clCreateBuffer</refentrytitle></citerefentry>
can be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> renderbuffer </varname> </term>
<listitem>
<para>
<!-- parameter description --> The name of a GL renderbuffer
object. The renderbuffer storage must be specified before the
image object can be created. The <varname>renderbuffer</varname>
format and dimensions defined by OpenGL will be used to create the
2D image object. Only GL renderbuffers with internal formats that
map to appropriate image channel order and data type specified in
the table of supported Image Channel Order Values <!-- table 5.5 -->
and the table of supported Image Channel Data Types <!-- table 5.6 --> for
<type><citerefentry><refentrytitle>cl_image_format</refentrytitle></citerefentry></type>
can be used to create the 2D image object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> errcode_ret </varname> </term>
<listitem>
<para>
<!-- parameter description --> Returns an appropriate error code as described
below. If <varname>errcode_ret</varname> is NULL, no error code is returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
<para>
If the state of a GL renderbuffer object is modified through the GL API (i.e. changes
to the dimensions or format used to represent pixels of the GL renderbuffer using
appropriate GL API calls such as <function>glRenderbufferStorage</function>) while
there exists a corresponding CL image object, subsequent use of the CL image object
will result in undefined behavior.
</para>
<para>
The <citerefentry><refentrytitle>clRetainMemObject</refentrytitle></citerefentry>
and <citerefentry><refentrytitle>clReleaseMemObject</refentrytitle></citerefentry>
functions can be used to retain and release the image objects.
</para>
<!-- table 9.4 -->
&gl_formatsInc;
</refsect1>
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<para>
Returns a valid non-zero OpenCL image object and <varname>errcode_ret</varname> is set
to CL_SUCCESS if the image object is created successfully. Otherwise, it returns a NULL
value with one of the following error values returned in <varname>errcode_ret</varname>:
</para>
<itemizedlist mark="disc">
<listitem>
<errorname>CL_INVALID_CONTEXT</errorname> if <varname>context</varname> is not
a valid context or was not created from a GL context.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if values specified in
<varname>flags</varname> are not valid.
</listitem>
<listitem>
<errorname>CL_INVALID_GL_OBJECT</errorname> if <varname>renderbuffer</varname> is not
a GL renderbuffer object or if the width or height of <varname>renderbuffer</varname>
is zero.
</listitem>
<listitem>
<errorname>CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</errorname> if the OpenGL renderbuffer
internal format does not map to a supported OpenCL image format.
</listitem>
<listitem>
<errorname>CL_INVALID_OPERATION</errorname> if <varname>renderbuffer</varname>
is a multi-sample GL renderbuffer object.
</listitem>
<listitem>
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the device.
</listitem>
<listitem>
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
</listitem>
</itemizedlist>
</refsect1>
<!-- ================================ EXAMPLE -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
<!--
<refsect2 id="example1">
<title>
Example
</title>
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
<tbody>
<row>
<entry>
Example goes here - it will be set in "code" type with white space preserved.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect2>
-->
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<olink uri="clCreateFromGLRenderbuffer">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>cl_khr_gl_sharing</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clCreateBuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>cl_image_format</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clRetainMemObject</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clReleaseMemObject</refentrytitle></citerefentry>
</para>
</refsect1>
<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
<para />
</refsect3>
<!-- 24-oct-2011 -->
</refentry>
|
