read_imagef_(3D) - Do an element lookup in the 3D image object, returning floating-point values.
Contents
Copyright
Copyright © 2007-2010 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.
Description
For the forms that take an image3d_t, use the coordinate (coord.x,coord.y,coord.z) to do an element
lookup in the 3D image object specified by image. coord.w is ignored.
For the forms that take an image3d_array_t, 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_imagef returns floating-point values in the range [0.0... 1.0] for image objects created with
image_channel_data_type set to one of the predefined packed formats or CL_UNORM_INT8 or CL_UNORM_INT16.
read_imagef returns floating-point values in the range [-1.0... 1.0] for image objects created with
image_channel_data_type set to CL_SNORM_INT8, or CL_SNORM_INT16.
read_imagef returns floating-point values for image objects created with image_channel_data_type set to
CL_HALF_FLOAT or CL_FLOAT.
The read_imagef calls that take integer coordinates must use a sampler with filter mode set to
CLK_FILTER_NEAREST, 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.
Values returned by read_imagef for image objects with image_channel_data_type values not specified in the
description above are undefined.
Name
read_imagef_(3D) - Do an element lookup in the 3D image object, returning floating-point values.
float4read_imagef(image3d_timage,sampler_tsampler,int4coord);float4read_imagef(image3d_timage,sampler_tsampler,float4coord);float4read_imagef(image3d_timage,int4coord);Notes
1. OpenCL Specification
page 292, section 6.12.14 - Image Read and Write Functions
The Khronos Group 11/18/2024 READ_IMAGEF(3D)(3clc)
See Also
imageFunctions(3clc)
Specification
OpenCLSpecification[1]
