async_work_group_copy

Perform an async copy.

event_t async_work_group_copy ( __local gentype *dst,
  const __global gentype *src,
  size_t  num_elements,
  event_t event)
event_t async_work_group_copy ( __global gentype *dst,
  const __local gentype *src,
  size_t num_elements,
  event_t event)

Description

The OpenCL C programming language implements these functions that provide asynchronous copies between global and local memory and a prefetch from global memory.

Perform an async copy of num_elements gentype elements from src to dst. The async copy 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 workgroup executing the kernel with the same argument values; otherwise the results are undefined.

Returns an event object that can be used by wait_group_events to wait for the async copy to finish. The event argument can also be used to associate the async_work_group_copy with a previous async copy allowing an event to be shared by multiple async copies; otherwise event should be zero.

If event argument is non-zero, the event object supplied in event argument will be returned.

This function does not perform any implicit synchronization of source data such as using a barrier before performing the copy.

Notes

Returns an event object that can be used by wait_group_events to wait for the async copy to finish.

The generic type name gentype indicates the built-in data types char, char{2|4|8|16}, uchar, uchar{2|4|8|16}, short, short{2|4|8|16}, ushort, ushort{2|4|8|16}, int, int{2|4|8|16}, uint, uint{2|4|8|16}, long, long{2|4|8|16}, ulong, ulong{2|4|8|16} or float, float{2|4|8|16} as the type for the arguments unless otherwise stated.

If extended with cl_khr_fp64, generic type name gentype may indicate double and double{2|4|8|16} as arguments and return values. If extended with cl_khr_fp16, generic type name gentype may indicate half and half{2|4|8|16} as arguments and return values.

Specification

OpenCL Specification

Also see

Async Copy and Prefetch Functions, wait_group_events

Copyright © 2007-2009 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.