--- name: "clEnqueueCopyImage" section: "3clc" platform: "linux" package: "opencl-1.2-man-doc" version: "1.0~svn33624-5.1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/clEnqueueCopyImage" --- # clEnqueueCopyImage(3clc) Enqueues a command to copy image objects. ## NAME clEnqueueCopyImage - Enqueues a command to copy image objects. ## **cl\_int clEnqueueCopyImage(cl\_command\_queue** *command\_queue***, cl\_mem** *src\_image***, cl\_mem** *dst\_image***, const size\_t \****src\_origin***, const size\_t \****dst\_origin***, const size\_t \****region***, cl\_uint** *num\_events\_in\_wait\_list***, const cl\_event \****event\_wait\_list***, cl\_event \****event***);** ## PARAMETERS *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\_image,* *dst\_image,* Can be 1D, 2D, 3D image or a 1D, 2D image array objects allowing us to perform the following actions: • Copy a 1D image object to a 1D image object. • Copy a 1D image object to a scanline of a 2D image object and vice-versa. • Copy a 1D image object to a scanline of a 2D slice of a 3D image object and vice-versa. • Copy a 1D image object to a scanline of a specific image index of a 1D or 2D image array object and vice-versa. • Copy a 2D image object to a 2D image object. • Copy a 2D image object to a 2D slice of a 3D image object and vice-versa. • Copy a 2D image object to a specific image index of a 2D image array object and vice versa. • Copy images from a 1D image array object to a 1D image array object. • Copy images from a 2D image array object to a 2D image array object. • Copy a 3D image object to a 3D image object. *src\_origin* Defines the (x, y, z) offset in pixels in the 1D, 2D or 3D image, the (x, y) offset and the image index in the 2D image array or the (x) offset and the image index in the 1D image array. If *image* is a 2D image object, *src\_origin*\[2\] must be 0. If *src\_image* is a 1D image object, *src\_origin*\[1\] and *src\_origin*\[2\] must be 0. If *src\_image* is a 1D image array object, *src\_origin*\[2\] must be 0. If *src\_image* is a 1D image array object, *src\_origin*\[1\] describes the image index in the 1D image array. If *src\_image* is a 2D image array object, *src\_origin*\[2\] describes the image index in the 2D image array. *dst\_origin* Defines the (x, y, z) offset in pixels in the 1D, 2D or 3D image, the (x, y) offset and the image index in the 2D image array or the (x) offset and the image index in the 1D image array. If *dst\_image* is a 2D image object, *dst\_origin*\[2\] must be 0. If *dst\_image* is a 1D image or 1D image buffer object, *dst\_origin*\[1\] and *dst\_origin*\[2\] must be 0. If *dst\_image* is a 1D image array object, *dst\_origin*\[2\] must be 0. If *dst\_image* is a 1D image array object, *dst\_origin*\[1\] describes the image index in the 1D image array. If *dst\_image* is a 2D image array object, *dst\_origin*\[2\] describes the image index in the 2D image array. *region* Defines the *(width, height, depth)* in pixels of the 1D, 2D or 3D rectangle, the *(width, height)* in pixels of the 2D rectangle and the number of images of a 2D image array or the *(width)* in pixels of the 1D rectangle and the number of images of a 1D image array. If *src\_image* or *dst\_image* is a 2D image object, *region*\[2\] must be 1. If *src\_image* or *dst\_image* is a 1D image or 1D image buffer object, *region*\[1\] and *region*\[2\] must be 1. If *src\_image* or *dst\_image* is a 1D image array object, *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. The memory associated with *event\_wait\_list* can be reused or freed after the function returns. *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. [**clEnqueueBarrierWithWaitList**(3clc)](/clEnqueueBarrierWithWaitList/3clc.md) can be used instead. If the *event\_wait\_list* and the *event* arguments are not NULL, the *event* argument should not refer to an element of the *event\_wait\_list* array. ## NOTES 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**(3clc)](/cl_image_format/3clc.md) descriptor specified when *src\_image* and *dst\_image* are created must match). ## ERRORS **clEnqueueCopyImage** returns CL\_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors: • CL\_INVALID\_COMMAND\_QUEUE if *command\_queue* is not a valid command-queue. • CL\_INVALID\_CONTEXT if the context associated with *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. • CL\_INVALID\_MEM\_OBJECT if *src\_image* and *dst\_image* are not valid image objects. • CL\_IMAGE\_FORMAT\_MISMATCH if *src\_image* and *dst\_image* do not use the same image format. • CL\_INVALID\_VALUE if the 2D or 3D rectangular region specified by *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*. • CL\_INVALID\_VALUE if values in *src\_origin*, *dst\_origin* and *region* do not follow rules described in the argument description for *src\_origin*, *dst\_origin* and *region*. • CL\_INVALID\_EVENT\_WAIT\_LIST if *event\_wait\_list* is NULL and *num\_events\_in\_wait\_list* \> 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. • CL\_INVALID\_IMAGE\_SIZE if image dimensions (image width, height, specified or compute row and/or slice pitch) for *src\_image* or *dst\_image* are not supported by device associated with *queue*. • CL\_INVALID\_IMAGE\_FORMAT if image format (image channel order and data type) for *src\_image* or *dst\_image* are not supported by device associated with *queue*. • CL\_MEM\_OBJECT\_ALLOCATION\_FAILURE if there is a failure to allocate memory for data store associated with *src\_image* or *dst\_image*. • CL\_OUT\_OF\_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device. • CL\_OUT\_OF\_HOST\_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host. • CL\_INVALID\_OPERATION if the device associated with *command\_queue* does not support images (i.e. **CL\_DEVICE\_IMAGE\_SUPPORT** specified in the table of OpenCL Device Queries for [**clGetDeviceInfo**(3clc)](/clGetDeviceInfo/3clc.md) is **CL\_FALSE**). • CL\_MEM\_COPY\_OVERLAP if *src\_image* and *dst\_image* are the same image object and the source and destination regions overlap. ## SPECIFICATION **OpenCL Specification**\[1\] ## SEE ALSO [**clEnqueueReadImage**(3clc)](/clEnqueueReadImage/3clc.md), [**clEnqueueWriteImage**(3clc)](/clEnqueueWriteImage/3clc.md) ## AUTHORS **The Khronos Group** ## COPYRIGHT Copyright © 2007-2011 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. ## NOTES - 1\. OpenCL Specification page 104, section 5.3.3 - Reading, Writing and Copying Image Objects