C Specification

To enqueue a command to fill an image object with a specified color, call the function

// Provided by CL_VERSION_1_2
cl_int clEnqueueFillImage(
    cl_command_queue command_queue,
    cl_mem image,
    const void* fill_color,
    const size_t* origin,
    const size_t* region,
    cl_uint num_events_in_wait_list,
    const cl_event* event_wait_list,
    cl_event* event);
clEnqueueFillImage is missing before version 1.2.

Parameters

  • 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[2] must be 0. If image is a 1D image or 1D image buffer object, origin[1] and origin[2] must be 0. If image is a 1D image array object, origin[2] must be 0. If image is a 1D image array object, origin[1] describes the image index in the 1D image array. If image is a 2D image array object, origin[2] describes the image index in the 2D image array. If image is a mipmapped image, the mip level to fill is determined from origin as described in Specifying Mipmap Levels to Image Operations

  • 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[2] must be 1. If image is a 1D image or 1D image buffer object, region[1] and region[2] must be 1. If image is a 1D image array object, region[2] 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 NULL or 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.

Description

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 cl_mem_flags argument value specified when image is created is ignored by clEnqueueFillImage.

clEnqueueFillImage 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 host command-queue

  • CL_INVALID_CONTEXT

    • if the context associated with command_queue and image are not the same

    • if the context associated with command_queue and events in event_wait_list are not the same

  • CL_INVALID_MEM_OBJECT

    • if image is not a valid image object

  • CL_INVALID_VALUE

    • if fill_color is NULL

    • if origin is NULL

    • if region is NULL

    • if the region being filled specified by origin and region is out of bounds

    • if values in origin and region do not follow the rules described in the argument description for origin and region

  • CL_INVALID_MIP_LEVEL

    • if the cl_khr_mipmap_image extension is supported and the mip level specified in origin is not a valid level for image

  • CL_INVALID_EVENT_WAIT_LIST

    • if event_wait_list is NULL and num_events_in_wait_list is greater than zero

    • if event_wait_list is not NULL and num_events_in_wait_list is zero

    • if event objects in event_wait_list are not valid events

  • CL_INVALID_IMAGE_SIZE

    • if the dimensions for image, such as the image width or image height, are not supported by the device associated with command_queue

  • CL_IMAGE_FORMAT_NOT_SUPPORTED

    • if the format for image, such as the image channel order or image channel data type, are not supported by the device associated with command_queue

  • CL_MEM_OBJECT_ALLOCATION_FAILURE

    • if there is a failure to allocate memory for the data store associated with image

  • CL_INVALID_OPERATION

    • if the device associated with command_queue does not support images (the query for CL_DEVICE_IMAGE_SUPPORT returns CL_FALSE)

    • if image was created with CL_MEM_IMMUTABLE_EXT

  • 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

See Also

CL_VERSION_1_2, cl_command_queue, cl_event, cl_mem, cl_uint

Document Notes

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.

Copyright

Copyright 2014-2026 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0