logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

write_image - Write color value to location in a 2D image object.

Authors

TheKhronosGroup

Description

write_imagef can only be used with image objects created with image_channel_data_type set to one of the
       pre-defined packed formats or set to CL_SNORM_INT8, CL_UNORM_INT8, CL_SNORM_INT16, CL_UNORM_INT16,
       CL_HALF_FLOAT or CL_FLOAT. Appropriate data format conversion will be done to convert channel data from a
       floating-point value to actual data format in which the channels are stored.

       write_imagei can only be used with image objects created with image_channel_data_type set to one of the
       following values: CL_SIGNED_INT8, CL_SIGNED_INT16, and CL_SIGNED_INT32.

       write_imageui functions can only be used with image objects created with image_channel_data_type set to
       one of the following values: CL_UNSIGNED_INT8, CL_UNSIGNED_INT16, or CL_UNSIGNED_INT32.

       An application that wants to use half and halfn types will need to include the #pragma OPENCL EXTENSION
       cl_khr_fp16(3clc) : enable directive.

       write_imageh can only be used with image objects created with image_channel_data_type set to one of the
       pre-defined packed formats or set to CL_SNORM_INT8, CL_UNORM_INT8, CL_SNORM_INT16, CL_UNORM_INT16 or
       CL_HALF_FLOAT.  Functions that take image2d_t.PP For the functions that take an image_2d_t image, write
       color value to location specified by coord.xy in the 2D image object specified by image. Appropriate data
       format conversion to the specified image format is done before writing the color value.  coord.x and
       coord.y are considered to be unnormalized coordinates and must be in the range 0 ... image width - 1, and
       0 ... image height - 1.

       For functions that take image_2d_t, the behavior of write_imagef, write_imagei, write_imageui, and
       write_imageh for image objects created with image_channel_data_type values not specified in the
       description above or with (x,y) coordinate values that are not in the range (0 ... image width - 1, 0
       ... image height - 1), respectively, is undefined.  Functions that take image2d_array_t.PP For the
       functions that take an image_2d_array_t image, write color value to location specified by coord.xy in the
       2D image identified by coord.z in the 2D image array specified by image. Appropriate data format
       conversion to the specified image format is done before writing the color value.  coord.x, coord.y and
       coord.z are considered to be unnormalized coordinates and must be in the range 0 ... image width - 1, 0
       ... image height - 1 and 0 ... image number of layers - 1.

       For functions that take image_2d_array_t, the behavior of write_imagef, write_imagei, write_imageui, and
       write_imageh for image objects created with image_channel_data_type values not specified in the
       description above or with (x,y,z) coordinate values that are not in the range (0 ... image width - 1, 0
       ... image height - 1), respectively, is undefined.

Name

       write_image - Write color value to location in a 2D image object.

       voidwrite_imagef(image2d_timage,int2coord,float4color);voidwrite_imagef(image2d_array_timage,int4coord,float4color);voidwrite_imagei(image2d_timage,int2coord,int4color);voidwrite_imagei(image2d_array_timage,int4coord,int4color);voidwrite_imageui(image2d_timage,int2coord,uint4color);voidwrite_imageui(image2d_array_timage,int4coord,uint4color);voidwrite_imageh(image2d_timage,int2coord,half4color);voidwrite_imageh(image2d_array_timage,int4coord,half4color);

Notes

        1. OpenCL Specification
           page 292, section 6.12.14 - Image Read and Write Functions

The Khronos Group                                  11/18/2024                             WRITE_IMAGE(2D)(3clc)

See Also

imageFunctions(3clc)

Specification

OpenCLSpecification[1]

See Also