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 3D image object.

Authors

TheKhronosGroup

Description

       Writes to a 3D image memory object are only supported when the cl_khr_3d_image_writes(3clc) extension is
       implemented. Reads and writes to the same 3D image memory object are not allowed in a kernel.

       An application that wants to use this extension to write to 3D image memory objects will need to include
       the #pragma OPENCL EXTENSION cl_khr_3d_image_writes(3clc) : enable directive in the OpenCL program
       source.

       These functions write color value to location specified by coordinate (x,y,z) in the 3D image object
       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 depth - 1.

       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, or CL_SIGNED_INT32.

       write_imageui 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.

       The behavior of write_imagef, write_imagei and write_imageui for image objects 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, 0 ... image depth - 1),
       respectively, is undefined.

       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.

       The behavior of 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, 0 ... image depth - 1), respectively, is undefined.

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

Name

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

       voidwrite_imagef(image3d_timage,int4coord,float4color);voidwrite_imagei(image3d_timage,int4coord,int4color);voidwrite_imageui(image3d_timage,int4coord,uint4color);voidwrite_imageh(image3d_timage,int4coord,half4color);

Notes

        1. OpenCL Specification
           page 12, section 9.4 - Writing to 3D image memory objects

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

See Also

imageFunctions(3clc), cl_khr_3d_image_writes(3clc) scalarDataTypes(3clc)

Specification

OpenCLSpecification[1]

See Also