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>get_local_id</keyword>
13
<refentrytitle>get_local_id</refentrytitle>
17
<year>2007-2011</year>
18
<holder>The Khronos Group Inc.
19
Permission is hereby granted, free of charge, to any person obtaining a
20
copy of this software and/or associated documentation files (the
21
"Materials"), to deal in the Materials without restriction, including
22
without limitation the rights to use, copy, modify, merge, publish,
23
distribute, sublicense, and/or sell copies of the Materials, and to
24
permit persons to whom the Materials are furnished to do so, subject to
25
the condition that this copyright notice and permission notice shall be included
26
in all copies or substantial portions of the Materials.</holder>
29
<manvolnum>3</manvolnum>
32
<!-- ================================ SYNOPSIS -->
34
<refnamediv id="get_local_id">
35
<refname>get_local_id</refname>
38
Returns the unique local work-item ID.
42
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
46
<link xlink:href="scalarDataTypes.html">size_t</link>
51
<paramdef><link xlink:href="scalarDataTypes.html">uint</link><parameter>dimindx</parameter></paramdef>
56
<!-- ================================ DESCRIPTION -->
58
<refsect1 id="description"><title>Description</title>
60
Returns the unique local work-item ID, i.e. a work-item
61
within a specific work-group for dimension identified by
62
<varname>dimindx</varname>. Valid values of <varname>dimindx</varname> are 0 to
63
<citerefentry><refentrytitle>get_work_dim</refentrytitle></citerefentry>() - 1. For other
64
values of <varname>dimindx</varname>, <function>get_local_id</function>() returns 0.
68
For <citerefentry><refentrytitle>clEnqueueTask</refentrytitle></citerefentry>, this
73
<!-- ================================ EXAMPLE -->
74
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
76
<refsect2 id="example1">
81
<informaltable frame="none">
82
<tgroup cols="1" align="left" colsep="0" rowsep="0">
83
<colspec colname="col1" colnum="1" />
87
Example goes here - it will be set in "code" type with white space preserved.
96
<!-- ================================ SPECIFICATION -->
97
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
99
<refsect1 id="specification"><title>Specification</title>
102
<imagedata fileref="pdficon_small1.gif" format="gif" />
105
<olink uri="workItemFunctions">OpenCL Specification</olink>
109
<!-- ================================ ALSO SEE -->
111
<refsect1 id="seealso"><title>Also see</title>
113
<citerefentry href="workItemFunctions"><refentrytitle>Work-Item Functions</refentrytitle></citerefentry>,
114
<citerefentry><refentrytitle>clEnqueueNDRangeKernel</refentrytitle></citerefentry>,
115
<citerefentry><refentrytitle>clEnqueueTask</refentrytitle></citerefentry>
119
<!-- ============================== COPYRIGHT -->
120
<!-- Content included from copyright.inc.xsl -->
122
<refsect3 id="Copyright"><title></title>
124
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
added
removed
get_local_id.xml
