[ ]>
read_imagei (1D)
read_imagei (1D)
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.
3
read_image{i|ui} (1D) Do an element lookup in the 1D image object, returning unnormalized signed integer and unsigned integer values.

##

int4 `read_imagei` image1d_t image sampler_t sampler int coord int4 `read_imagei` image1d_t image sampler_t sampler float coord uint4 `read_imageui` image1d_t image sampler_t sampler int coord uint4 `read_imageui` image1d_t image sampler_t sampler float coord int4 `read_imagei` image1d_t image int coord uint4 `read_imageui` image1d_t image int coord int4 `read_imagei` image1d_buffer_t image int coord uint4 `read_imageui` image1d_buffer_t image int coord int4 `read_imagei` image1d_array_t image int2 coord uint4 `read_imageui` image1d_array_t image int2 coord int4 `read_imagei` image1d_array_t image sampler_t sampler int2 coord int4 `read_imagei` image1d_array_t image sampler_t sampler float2 coord uint4 `read_imageui` image1d_array_t image sampler_t sampler int2 coord uint4 `read_imageui` image1d_array_t image sampler_t sampler float2 coord

## Description

For the forms that take an image1d_t, 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 image1d_array_t, use coord.x to do an element lookup in the 1D image identified by coord.y in the 1D 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` returned are undefined. and `read_imageui` calls that take integer coordinates must use a returned are undefined. sampler with normalized coordinates set to `CLK_NORMALIZED_COORDS_FALSE` and addressing returned are undefined. mode set to `CLK_ADDRESS_CLAMP_TO_EDGE`, `CLK_ADDRESS_CLAMP` or `CLK_ADDRESS_NONE`; otherwise returned are undefined. the values returned are undefined. returned are undefined.

## Notes

&imageFunctionsInc; &imageMappingInc;

## Specification

OpenCL Specification

## Also see

Image Functions

##