sdk/2.1/docs/man/get_kernel_preferred_work_group_size_multiple.xml

<?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>get_kernel_preferred_work_group_size_multiple</keyword>
        </keywordset>
    </refentryinfo>

    <refmeta>
        <refentrytitle>get_kernel_preferred_work_group_size_multiple</refentrytitle>

        <refmiscinfo>
            <copyright>
                <year>2007-2013</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="get_kernel_preferred_work_group_size_multiple">
        <refname>get_kernel_preferred_work_group_size_multiple</refname>

        <refpurpose>
            Returns the preferred multiple of work-group size for launch.
        </refpurpose>
    </refnamediv>

    <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>
                    <link xlink:href="scalarDataTypes.html">uint</link>
                    <function>
                        get_kernel_preferred_work_group_size_multiple
                    </function>
                </funcdef>
            <paramdef>
                <link xlink:href="scalarDataTypes.html">void</link>
                (^block)(void)<parameter></parameter>
            </paramdef>
            </funcprototype>
        </funcsynopsis>

        <funcsynopsis>
            <funcprototype>
                <funcdef>
                    <link xlink:href="scalarDataTypes.html">uint</link>
                    <function>
                        get_kernel_preferred_work_group_size_multiple
                    </function>
                </funcdef>
            <paramdef>
                <link xlink:href="scalarDataTypes.html">void</link>
                (^block)(local void*, ...)<parameter></parameter>
            </paramdef>
            </funcprototype>
        </funcsynopsis>

    </refsynopsisdiv>

<!-- ================================ DESCRIPTION  -->

    <refsect1 id="description"><title>Description</title>

        <para>
            This kernel query function returns the preferred multiple of work-group
            size for launch. This is a performance hint.
            Specifying a work-group size that is not a
            multiple of the value returned by this query
            as the value of the local work size argument
            to <varname>enqueue_kernel</varname> will not fail to
            enqueue the block for execution unless the
            work-group size specified is larger than the
            device maximum.
        </para>
    </refsect1>

<!-- ================================ NOTES   -->

    <refsect1 id="notes"><title>Notes</title>
        <para>
            If the
            <citerefentry><refentrytitle>cl_khr_device_enqueue_local_arg_types</refentrytitle></citerefentry>
            extension is enabled, then replace all occurrences of
            <code>local void *</code>
            in the table above with
            <code>local gentype *</code>.
            We use the generic type name <code>gentype</code>
            to indicate the built-in OpenCL C scalar or
            vector integer or floating-point data types, or
            any user defined type built from these scalar and
            vector data types which can be used as the type
            of the pointee of the arguments of the kernel
            enqueue functions listed above.
        </para>
    </refsect1>


<!-- ================================ 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="kernelQueryFunctions">OpenCL Specification</olink>
        </para>
    </refsect1>

<!-- ================================ ALSO SEE  -->

    <refsect1 id="seealso"><title>Also see</title>
        <para>
            <citerefentry><refentrytitle>get_kernel_work_group_size</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>

<!-- 4-Nov-2015, API ver 2.1 rev 19; Ext ver 2.1 rev 10; C lang ver 2.0 rev 30 -->
</refentry>