read_image{i|ui}_(2D) - Do an element lookup in the 2D image object, returning unnormalized signed

TheKhronosGroup

       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.

       For the forms that take an image2d_t object, use the coordinate (coord.x,coord.y) to do an element
       lookup in the 2D image object specified by image.

       For the forms that take an image2d_array_t object, use coord.xy to do an element lookup in the 2D image
       identified by coord.z in the 2D image array specified by image.

       The samplerless read image functions behave exactly as the corresponding read image functions that take
       integer coordinates and a sampler with filter mode set to CLK_FILTER_NEAREST, normalized coordinates set
       to CLK_NORMALIZED_COORDS_FALSE and addressing mode to CLK_ADDRESS_NONE.

       read_imagei and read_imageui return unnormalized signed integer and unsigned integer values respectively.
       Each channel will be stored in a 32-bit integer.

       read_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. If the image_channel_data_type is
       not one of the above values, the values returned by read_imagei are undefined.

       read_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, and CL_UNSIGNED_INT32. If the
       image_channel_data_type is not one of the above values, the values returned by read_imageui are
       undefined.

       The read_imagei and read_imageui calls support a nearest filter only. The filter_mode specified in
       sampler must be set to CLK_FILTER_NEAREST; otherwise the values returned are undefined.

       Furthermore, the read_imagei and read_imageui calls that take integer coordinates must use a sampler with
       normalized coordinates set to CLK_NORMALIZED_COORDS_FALSE and addressing mode set to
       CLK_ADDRESS_CLAMP_TO_EDGE, CLK_ADDRESS_CLAMP or CLK_ADDRESS_NONE; otherwise the values returned are
       undefined.

       read_image{i|ui}_(2D) - Do an element lookup in the 2D image object, returning unnormalized signed
       integer and unsigned integer values.

       int4read_imagei(image2d_timage,sampler_tsampler,int2coord);int4read_imagei(image2d_timage,sampler_tsampler,float2coord);uint4read_imageui(image2d_timage,sampler_tsampler,int2coord);int4read_imagei(image2d_timage,int2coord);uint4read_imageui(image2d_timage,int2coord);int4read_imagei(image2d_array_timage,int4coord);uint4read_imageui(image2d_array_timage,int4coord);int4read_imagei(image2d_array_timage,sampler_tsampler,int4coord);int4read_imagei(image2d_array_timage,sampler_tsampler,float4coord);int4read_imageui(image2d_array_timage,sampler_tsampler,int4coord);int4read_imageui(image2d_array_timage,sampler_tsampler,float4coord);uint4read_imageui(image2d_array_timage,sampler_tsampler,int4coord);uint4read_imageui(image2d_array_timage,sampler_tsampler,float4coord);

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

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

imageFunctions(3clc)

OpenCLSpecification[1]