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
|
<?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">
<refentry>
<refentryinfo>
<keywordset>
<keyword>clCreateSampler</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>
clCreateSampler
</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="clCreateSampler">
<refname>
clCreateSampler
</refname>
<refpurpose>
Creates a sampler object.
</refpurpose>
</refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="abstractDataTypes.html">cl_sampler</link> <function>clCreateSampler</function>
</funcdef>
<paramdef><link xlink:href="abstractDataTypes.html">cl_context</link><parameter>context</parameter></paramdef>
<paramdef><link xlink:href="enums.html#cl_bool">cl_bool</link><parameter>normalized_coords</parameter></paramdef>
<paramdef><link xlink:href="enums.html#cl_addressing_mode">cl_addressing_mode</link><parameter>addressing_mode</parameter></paramdef>
<paramdef><link xlink:href="enums.html#cl_filter_mode">cl_filter_mode</link><parameter>filter_mode</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 -->
Must be a valid OpenCL context.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> normalized_coords </varname> </term>
<listitem>
<para> <!-- parameter description -->
Determines if the image coordinates specified are normalized (if
<varname>normalized_coords</varname> is <constant>CL_TRUE</constant>) or
not (if <varname>normalized_coords</varname> is <constant>CL_FALSE</constant>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> addressing_mode </varname> </term>
<listitem>
<para> <!-- parameter description -->
Specifies how out-of-range image coordinates are handled when reading from
an image. This can be set to <constant>CL_ADDRESS_MIRRORED_REPEAT</constant>,
<constant>CL_ADDRESS_REPEAT</constant>, <constant>CL_ADDRESS_CLAMP_TO_EDGE</constant>,
<constant>CL_ADDRESS_CLAMP</constant>, and <constant>CL_ADDRESS_NONE</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> filter_mode </varname> </term>
<listitem>
<para> <!-- parameter description -->
Specifies the type of filter that must be applied when reading an image. This can be
<constant>CL_FILTER_NEAREST</constant> or <constant>CL_FILTER_LINEAR</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> errcode_ret </varname> </term>
<listitem>
<para>
<!-- parameter description --> Returns an appropriate error code. If
<varname>errcode_ret</varname> is NULL, no error code is returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
<para>
<!-- should this paragraph be replicated in other sampler-related pages? [core spec
p. 126, section 5.5.1] --> A sampler object describes how to sample an image when the
image is read in the kernel. The built-in functions to read from an image in a kernel
take a sampler as an argument. The sampler arguments to the image read function can
be sampler objects created using OpenCL functions and passed as argument values to
the kernel or can be samplers declared inside a kernel. In this section we discuss
how sampler objects are created using OpenCL functions.
</para>
<para>
For more information about working with samplers, see
<citerefentry><refentrytitle>sampler_t</refentrytitle></citerefentry>
</para>
</refsect1>
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<para>
Returns a valid non-zero sampler object and <varname>errcode_ret</varname> is set to
<errorname>CL_SUCCESS</errorname> if the sampler 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.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>addressing_mode</varname>,
<varname>filter_mode</varname>, or <varname>normalized_coords</varname> or a
combination of these argument values are not valid.
</listitem>
<listitem>
<errorname>CL_INVALID_OPERATION</errorname> if images are not
supported by any device associated with <varname>context</varname>
(i.e. <errorname>CL_DEVICE_IMAGE_SUPPORT</errorname>
specified in the table of OpenCL Device Queries for
<citerefentry><refentrytitle>clGetDeviceInfo</refentrytitle></citerefentry>
is <errorname>CL_FALSE</errorname>).
</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="clCreateSampler">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>clRetainSampler</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clReleaseSampler</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clGetSamplerInfo</refentrytitle></citerefentry>,
<citerefentry href="classDiagram"><refentrytitle>Cardinality Diagram</refentrytitle></citerefentry>
<citerefentry><refentrytitle>sampler_t</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>
<!-- 21-Oct-2011 -->
</refentry>
|
