To enqueue a command to fill an image object with a specified color, call the function
const void* fill_color,
const size_t* origin,
const size_t* region,
const cl_event* event_wait_list,
|clEnqueueFillImage is missing before version 1.2.
command_queue refers to the host command-queue in which the fill command will be queued. The OpenCL context associated with command_queue and image must be the same.
image is a valid image object.
fill_color is the color used to fill the image. The fill color is a single floating-point value if the channel order is
CL_DEPTH. Otherwise, the fill color is a four component RGBA floating-point color value if the image channel data type is not an unnormalized signed or unsigned integer type, is a four component signed integer value if the image channel data type is an unnormalized signed integer type and is a four component unsigned integer value if the image channel data type is an unnormalized unsigned integer type. The fill color will be converted to the appropriate image channel format and order associated with image.
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, origin must be 0. If image is a 1D image or 1D image buffer object, origin and origin must be 0. If image is a 1D image array object, origin must be 0. If image is a 1D image array object, origin describes the image index in the 1D image array. If image is a 2D image array object, origin 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 image is a 2D image object, region must be 1. If image is a 1D image or 1D image buffer object, region and region must be 1. If image is a 1D image array object, region must be 1. The values in region cannot be 0.
event_wait_list and 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 command and can be used to query or queue a wait for this command to complete. If event is
NULLor the enqueue is unsuccessful, no event will be created and therefore it will not be possible to query the status of this command or to wait for this command to complete. If event_wait_list and event are not
NULL, event must not refer to an element of the event_wait_list array.
The usage information which indicates whether the memory object can be read
or written by a kernel and/or the host and is given by the
argument value specified when image is created is ignored by
CL_SUCCESS if the function is executed
Otherwise, it returns one of the following errors:
CL_INVALID_if command_queue is not a valid host command-queue.
CL_INVALID_if the context associated with command_queue and 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_if image is not a valid image object.
CL_INVALID_if fill_color is
CL_INVALID_if origin or region is
CL_INVALID_if the region being filled as specified by origin and region is out of bounds.
CL_INVALID_if values in origin and region do not follow rules described in the argument description for origin and region.
CL_INVALID_if event_wait_list is
EVENT_ WAIT_ LIST
NULLand num_events_in_wait_list > 0, or event_wait_list is not
NULLand num_events_in_wait_list is 0, or if event objects in event_wait_list are not valid events.
CL_INVALID_if image dimensions (image width, height, specified or compute row and/or slice pitch) for image are not supported by device associated with queue.
CL_IMAGE_if image format (image channel order and data type) for image are not supported by device associated with queue.
FORMAT_ NOT_ SUPPORTED
CL_MEM_if there is a failure to allocate memory for data store associated with image.
OBJECT_ ALLOCATION_ FAILURE
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the device.
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the host.
OF_ HOST_ MEMORY
For more information, see the OpenCL Specification
This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.