blob: c549b5b88ef79751038399fb3b5b748aff8c93f9 [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="get_local_size">
Returns the number of local work-items in the specified dimension.
<refsynopsisdiv xmlns:xlink=""><title></title>
<link xlink:href="scalarDataTypes.html">size_t</link>
<paramdef><link xlink:href="scalarDataTypes.html">uint</link><parameter>dimindx</parameter></paramdef>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
Returns the number of local work-items specified in dimension
identified by <varname>dimindx</varname>. This value
is at most the value given by the <varname>local_work_size</varname> argument to
<citerefentry><refentrytitle>clEnqueueNDRangeKernel</refentrytitle></citerefentry> if
<varname>local_work_size</varname> is not NULL; otherwise the OpenCL implementation
chooses an appropriate <varname>local_work_size</varname> value which is
returned by this function.
If the kernel is executed with a nonuniform work-group size
(i.e. the <varname>global_work_size</varname> values specified to
are not evenly divisable by the
<varname>local_work_size</varname> values for each dimension),
calls to this built-in from
some work-groups may return different values than calls
to this built-in from other work-groups.
Valid values of <varname>dimindx</varname> are 0 to
<citerefentry><refentrytitle>get_work_dim</refentrytitle></citerefentry>() - 1. For other
values of <varname>dimindx</varname>, <function>get_local_size</function>() returns 1.
<!-- ================================ 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="workItemFunctions">OpenCL Specification</olink>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<citerefentry href="workItemFunctions"><refentrytitle>Work-Item Functions</refentrytitle></citerefentry>,
<!-- ============================== COPYRIGHT -->
<!-- Content included from -->
<refsect3 id="Copyright"><title></title>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
<para />
<!-- 12-Dec-2013, rev. 19 -->