command_queue
Refers to the command-queue in which the copy command will be queued. The
OpenCL context associated with command_queue
, src_image
and dst_image
must be the same.
src_origin
Defines the starting (x, y, z) location in pixels in src_image
from where to start the data copy. If src_image
is a 2D image object, the z value given by src_origin
[2] must be 0.
dst_origin
Defines the starting (x, y, z) location in pixels in dst_image
from where to start the data copy. If dst_image
is a 2D image object, the z value given by dst_origin
[2] must be 0.
region
Defines the (width
, height
, depth
) in pixels of the 2D or 3D rectangle to copy. If src_image
or dst_image
is a 2D image object, the depth
value given by region
[2] must be 1.
event_wait_list
,
num_events_in_wait_list
Specify events that need to complete before this particular command can be executed. If event_wait_list
is NULL, then this particular command does not wait on any event to complete. If event_wait_list
is NULL, num_events_in_wait_list
must be 0. If event_wait_list
is not NULL, the list of events pointed to by event_wait_list
must be valid and num_events_in_wait_list
must be greater than 0. The events specified in event_wait_list
act as synchronization points. The context associated with events in event_wait_list
and command_queue
must be the same.
event
Returns an event object that identifies this particular copy command and can be used to query or queue a wait for this particular command to complete. event
can be NULL in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. clEnqueueBarrier can be used instead.
It is currently a requirement that the src_image
and dst_image
image memory objects for clEnqueueCopyImage
must have the exact same image format (i.e. the cl_image_format descriptor specified when src_image
and dst_image
are created must match).
src_image
and dst_image
can be 2D or 3D image objects
allowing us to perform the following actions:
clEnqueueCopyImage
returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:
command_queue
is not a valid command-queue.
command_queue
, src_image
and dst_image
are not the same or if the context associated with command_queue
and events
in event_wait_list
are not the same.
src_image
and dst_image
are not valid image objects.
src_image
and dst_image
do not use the same
image format.
src_origin
and src_origin
+ region
refers to a region outside src_image
,
or if the 2D or 3D rectangular region specified by dst_origin
and dst_origin
+ region
refers to a region outside dst_image
.
src_image
is a 2D image object and src_origin
[2]
is not equal to 0 or region
[2] is not equal to 1.
dst_image
is a 2D image object and dst_origin
[2]
is not equal to 0 or region
[2] is not equal to 1.
event_wait_list
is NULL and
num_events_in_wait_list
greater than 0, or event_wait_list
is not NULL
and num_events_in_wait_list
is 0, or if event objects in event_wait_list
are not valid events.
src_image
are not supported by device associated with queue
.
dst_image
are not supported by device associated with queue
.
src_image
or dst_image
.
command_queue
does not support images
(i.e. CL_DEVICE_IMAGE_SUPPORT specified in the table of OpenCL Device Queries
for clGetDeviceInfo is CL_FALSE).
src_image
and dst_image
are the
same image object and the source and destination regions overlap.