'\" t
.\"     Title: async_work_group_strided_copy
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "ASYNC_WORK_GROUP_STR" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
async_work_group_strided_copy \- Performs an async gather of num_elements gentype elements from source to destination\&.
.SH ""
.HP \w'event_t\ async_work_group_strided_copy('u
.BI "event_t async_work_group_strided_copy(__local\ gentype\ *" "dst" ", const\ __global\ gentype\ *" "src" ", size_t\ " "num_gentypes" ", size_t\ " "src_stride" ", event_t\ " "event" ");"
.HP \w'event_t\ async_work_group_strided_copy('u
.BI "event_t async_work_group_strided_copy(__global\ gentype\ *" "dst" ", const\ __local\ gentype\ *" "src" ", size_t\ " "num_gentypes" ", size_t\ " "dst_stride" ", event_t\ " "event" ");"
.SH "DESCRIPTION"
.PP
The OpenCL C programming language implements these functions that provide asynchronous copies between global and local memory and a prefetch from global memory\&.
.PP
Perform an async gather of
\fInum_gentypes\fR
\fBgentype\fR
elements from
\fIsrc\fR
to
\fIdst\fR\&. The
\fIsrc_stride\fR
is the stride in elements for each
\fBgentype\fR
element read from
\fIsrc\fR\&. The
\fIdst_stride\fR
is the stride in elements for each
\fBgentype\fR
element written to
\fIdst\fR\&. The async gather is performed by all work\-items in a work\-group\&.
.PP
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\&.
.PP
Returns an event object that can be used by
\fBwait_group_events\fR(3clc)
to wait for the async copy to finish\&. The
\fIevent\fR
argument can also be used to associate the
\fBasync_work_group_strided_copy\fR
with a previous async copy allowing an event to be shared by multiple async copies; otherwise
\fIevent\fR
should be zero\&.
.PP
If
\fIevent\fR
argument is non\-zero, the event object supplied in
\fIevent\fR
argument will be returned\&.
.PP
This function does not perform any implicit synchronization of source data such as using a
\fBbarrier\fR(3clc)
before performing the copy\&.
.PP
The behavior of
\fBasync_work_group_strided_copy\fR
is undefined if
\fIsrc_stride\fR
or
\fIdst_stride\fR
is 0, or if the
\fIsrc_stride\fR
or
\fIdst_stride\fR
values cause the
\fIsrc\fR
or
\fIdst\fR
pointers to exceed the upper bounds of the address space during the copy\&.
.SH "NOTES"
.PP
The generic type name
\fBgentype\fR
indicates the built\-in data types
\fBchar\fR,
\fBchar{2|3|4|8|16}\fR,
\fBuchar\fR,
\fBuchar{2|3|4|8|16}\fR,
\fBshort\fR,
\fBshort{2|3|4|8|16}\fR,
\fBushort\fR,
\fBushort{2|3|4|8|16}\fR,
\fBint\fR,
\fBint{2|3|4|8|16}\fR,
\fBuint\fR,
\fBuint{2|3|4|8|16}\fR,
\fBlong\fR,
\fBlong{2|3|4|8|16}\fR,
\fBulong\fR,
\fBulong{2|3|4|8|16}\fR
or
\fBfloat\fR,
\fBfloat{2|3|4|8|16}\fR
as the type for the arguments unless otherwise stated\&.
.PP
Optionally, generic type name
\fBgentype\fR
may indicate
\fBdouble\fR
and
\fBdouble{2|3|4|8|16}\fR
as arguments and return values\&. If extended with
\fBcl_khr_fp16\fR(3clc), generic type name
\fBgentype\fR
may indicate
\fBhalf\fR
and
\fBhalf{2|3|4|8|16}\fR
as arguments and return values\&.
.PP
\fBasync_work_group_copy\fR
and
\fBasync_work_group_strided_copy\fR
for 3\-component vector types behave as
\fBasync_work_group_copy\fR
and
\fBasync_work_group_strided_copy\fR
respectively for 4\-component vector types\&.
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBasyncCopyFunctions\fR(3clc),
\fBwait_group_events\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 276, section 6.12.10 - Async Copies from Global to Local Memory...
.RE