blob: dabdd8602a27aaed38a62cb05a474dafa644905e [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
<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>
<!-- ================================ SYNOPSIS -->
<refnamediv id="clReleaseDevice">
Decrements the <varname>device</varname> reference count.
<refsynopsisdiv xmlns:xlink=""><title></title>
<link xlink:href="scalarDataTypes.html">cl_int</link> <function>clReleaseDevice</function>
<paramdef><link xlink:href="abstractDataTypes.html">cl_device_id</link><parameter>device</parameter></paramdef>
<!-- ================================ PARAMETERS -->
<!-- <refsect1 id="parameters">
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
Decrements the <varname>device</varname> reference
count if device is a valid sub-device created by a call to
If <varname>device</varname> is a root level device i.e. a <type>cl_device_id</type>
returned by <citerefentry><refentrytitle>clGetDeviceIDs</refentrytitle></citerefentry>,
the <varname>device</varname> reference count remains unchanged.
After the <varname>device</varname> reference count becomes zero and all the objects
attached to <varname>device</varname> (such as command-queues) are released, the
<varname>device</varname> object is deleted.
Using this function to release a
reference that was not obtained by creating the object or by calling
causes undefined behavior.
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
Returns <errorname>CL_SUCCESS</errorname> if the function is executed successfully.
Otherwise, it returns one of the following errors:
<itemizedlist mark="disc">
<errorname>CL_INVALID_DEVICE</errorname> if <varname>device</varname>
is not a valid sub-device created by a call to
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the device.
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
<!-- ================================ EXAMPLE -->
<refsect2 id="example1">
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
Example goes here - it will be set in "code" type with white space preserved.
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
<refsect1 id="specification"><title>Specification</title>
<imagedata fileref="pdficon_small1.gif" format="gif" />
<olink uri="clReleaseDevice">OpenCL Specification</olink>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<!-- ================================ COPYRIGHT -->
<!-- Content included from -->
<refsect3 id="Copyright"><title></title>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
<para />
<!-- 27-Oct-2015, API rev. 19 -->