<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }

                .term {
                        font: italic 16px verdana, sans-serif;
                        font-weight: normal;
                }

                .type {
                        font: normal 16px verdana, sans-serif !important;
                }

                .parameter {
                        font-style: italic;
                        }

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
                        padding-top: 10px;
                        padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }

                span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }

        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }

        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
                        margin-top: 10px;
            background-color: #FFF;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
                        font: normal 16px verdana, sans-serif;
        }

        div.refsect1 th {
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }

        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }

                  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }


        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
                        white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }

</style>
    <title>async_work_group_strided_copy</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <meta name="keywords" content="async_work_group_strided_copy" />
  </head>
  <body>
    <div class="refentry">
      <a id="id-1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <a xmlns="http://www.w3.org/1999/xhtml" id="async_work_group_copy"></a>
        <h1>async_work_group_strided_copy</h1>
        <p>
            Performs an async gather of <code xmlns="http://www.w3.org/1999/xhtml" class="varname">num_elements</code> <span xmlns="http://www.w3.org/1999/xhtml" class="type">gentype</span> elements from source to destination.
        </p>
      </div>
      <div class="refsynopsisdiv">
        <h2></h2>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    <a class="link" href="otherDataTypes.html" target="pagedisplay">event_t</a>
                    <strong class="fsfunc">
                        async_work_group_strided_copy
                    </strong>
                (</code>
                <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="local.html" target="pagedisplay">__local</a> gentype <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*dst</var>, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="global.html" target="pagedisplay">__global</a> gentype <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*src</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_gentypes</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">src_stride</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="otherDataTypes.html" target="pagedisplay">event_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">event</var><code>)</code></td>
            </tr>
          </table>
        </div>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    <a class="link" href="otherDataTypes.html" target="pagedisplay">event_t</a>
                    <strong class="fsfunc">
                        async_work_group_strided_copy
                    </strong>
                (</code>
                <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="global.html" target="pagedisplay">__global</a> gentype <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*dst</var>, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="local.html" target="pagedisplay">__local</a> gentype <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*src</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_gentypes</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">dst_stride</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="otherDataTypes.html" target="pagedisplay">event_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">event</var><code>)</code></td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="description"></a>
        <h2>Description</h2>
        <p>
          <code class="function">async_work_group_strided_copy</code> performs an async gather of 
          <code class="varname">num_gentypes</code> <span class="type">gentype</span> elements
          from <code class="varname">src</code> to <code class="varname">dst</code>. The <code class="varname">src_stride</code>
          is the stride in elements for each <span class="type">gentype</span> element read from
          <code class="varname">src</code>.  The async
          gather is performed by all work-items in a work-group and this built-in
          function must therefore be encountered by
          all work-items in a work-group executing
          the kernel with the same argument values;
          otherwise the results are undefined.
          This rule applies to ND-ranges implemented with uniform
          and non-uniform work-groups.
        </p>
        <p>
          Returns an event object that can be used by
          <a class="citerefentry" href="wait_group_events.html"><span class="citerefentry"><span class="refentrytitle">wait_group_events</span></span></a>
          to wait for the async copy to finish. The <code class="varname">event</code> argument can
          also be used to associate the <code class="function">async_work_group_strided_copy</code>
          with a previous async copy allowing an event to be shared by multiple async copies;
          otherwise <code class="varname">event</code> should be zero.
        </p>
        <p>
          If <code class="varname">event</code> argument is non-zero, the event object supplied in
          <code class="varname">event</code> argument will be returned.
        </p>
        <p>
          This function does not perform any implicit synchronization of source data such as
          using a <a class="citerefentry" href="barrier.html"><span class="citerefentry"><span class="refentrytitle">barrier</span></span></a> before
          performing the copy.
        </p>
        <p>
          The behavior of <code class="function">async_work_group_strided_copy</code> is undefined
          if <code class="varname">src_stride</code> or <code class="varname">dst_stride</code> is 0, or if the
          <code class="varname">src_stride</code> or <code class="varname">dst_stride</code> values cause the
          <code class="varname">src</code> or <code class="varname">dst</code> pointers to exceed the upper bounds
          of the address space during the copy.
        </p>
        <p>
        General information about async copy functions:
        The generic type name <span class="type">gentype</span> indicates the built-in data
        types <span class="type">char</span>,  <span class="type">char{2|3|4|8|16}</span>, <span class="type">uchar</span>,
        <span class="type">uchar{2|3|4|8|16}</span>, <span class="type">short</span>, <span class="type">short{2|3|4|8|16}</span>,
        <span class="type">ushort</span>, <span class="type">ushort{2|3|4|8|16}</span>, <span class="type">int</span>,
        <span class="type">int{2|3|4|8|16}</span>, <span class="type">uint</span>, <span class="type">uint{2|3|4|8|16}</span>,
        <span class="type">long</span>, <span class="type">long{2|3|4|8|16}</span>, <span class="type">ulong</span>,
        <span class="type">ulong{2|3|4|8|16}</span>, <span class="type">float</span>, <span class="type">float{2|3|4|8|16}</span>, or
        <span class="type">double</span>, <span class="type">double{2|3|4|8|16}</span>
        as the type for the arguments unless otherwise stated.
    </p>
        <p>
          When extended by the
          <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a> extension,
          the generic type <span class="type">gentype<em class="replaceable"><code>n</code></em></span> is extended to
          include <span class="type">half</span>, <span class="type">half2</span>, <span class="type">half3</span>, <span class="type">half4</span>,
          <span class="type">half8</span>, and <span class="type">half16</span>.
        </p>
      </div>
      <div class="refsect1">
        <a id="notes"></a>
        <h2>Notes</h2>
        <p>
        <code class="function">async_work_group_copy</code> and
        <code class="function">async_work_group_strided_copy</code> for 3-component
        vector types behave as <code class="function">async_work_group_copy</code> and
        <code class="function">async_work_group_strided_copy</code> respectively for 4-component vector
        types.
      </p>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />

            <a href="https://www.khronos.org/registry/cl/specs/opencl-2.1-openclc.pdf#page=100" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="asyncCopyFunctions.html"><span class="citerefentry"><span class="refentrytitle">Async Copy and Prefetch  Functions</span></span></a>
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2015 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.
</div>
    </div>
  </body>
</html>