1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
8
<keyword>clReleaseSampler</keyword>
19
<year>2007-2011</year>
20
<holder>The Khronos Group Inc.
21
Permission is hereby granted, free of charge, to any person obtaining a
22
copy of this software and/or associated documentation files (the
23
"Materials"), to deal in the Materials without restriction, including
24
without limitation the rights to use, copy, modify, merge, publish,
25
distribute, sublicense, and/or sell copies of the Materials, and to
26
permit persons to whom the Materials are furnished to do so, subject to
27
the condition that this copyright notice and permission notice shall be included
28
in all copies or substantial portions of the Materials.</holder>
31
<manvolnum>3</manvolnum>
34
<!-- ================================ SYNOPSIS -->
36
<refnamediv id="clReleaseSampler">
42
Decrements the sampler reference count.
46
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
50
<link xlink:href="scalarDataTypes.html">cl_int</link>
51
<function>clReleaseSampler</function>
54
<paramdef><link xlink:href="abstractDataTypes.html">cl_sampler</link><parameter>sampler</parameter></paramdef>
59
<!-- ================================ PARAMETERS -->
61
<refsect1 id="parameters">
62
<title>Parameters</title>
66
<varname>sampler<!-- parameter name -->
71
Specifies the <varname>sampler</varname> being retained.
77
<!-- ================================ NOTES -->
79
<refsect1 id="notes"><title>Notes</title>
81
The sampler object is deleted after the reference count becomes zero and commands queued
82
for execution on a command-queue(s) that use <varname>sampler</varname> have finished.
86
<!-- ================================ ERRORS -->
88
<refsect1 id="errors"><title>Errors</title>
90
Returns <errorname>CL_SUCCESS</errorname> if the function is executed successfully.
91
Otherwise, it returns one of the following errors:
94
<itemizedlist mark="disc">
96
<errorname>CL_INVALID_SAMPLER</errorname> if <varname>sampler</varname> is not
97
a valid sampler object.
101
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
102
resources required by the OpenCL implementation on the device.
106
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
107
resources required by the OpenCL implementation on the host.
112
<!-- ================================ EXAMPLE -->
113
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
115
<refsect2 id="example1">
120
<informaltable frame="none">
121
<tgroup cols="1" align="left" colsep="0" rowsep="0">
122
<colspec colname="col1" colnum="1" />
126
Example goes here - it will be set in "code" type with white space preserved.
135
<!-- ================================ SPECIFICATION -->
136
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
138
<refsect1 id="specification"><title>Specification</title>
141
<imagedata fileref="pdficon_small1.gif" format="gif" />
144
<olink uri="clReleaseSampler">OpenCL Specification</olink>
148
<!-- ================================ ALSO SEE -->
150
<refsect1 id="seealso"><title>Also see</title>
152
<citerefentry><refentrytitle>clCreateSampler</refentrytitle></citerefentry>,
153
<citerefentry><refentrytitle>clRetainSampler</refentrytitle></citerefentry>,
154
<citerefentry><refentrytitle>clGetSamplerInfo</refentrytitle></citerefentry>
158
<!-- ================================ COPYRIGHT -->
159
<!-- Content included from copyright.inc.xsl -->
161
<refsect3 id="Copyright"><title></title>
163
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
added
removed
clReleaseSampler.xml
