READ_IMAGEF3D(3clc)

📦
version 1.0~svn33624 · 3 versions
, in ubuntu jammy, ubuntu noble

💖 READ_IMAGEF (3D) 💖

ok bestie, welcome to the read_imagef_(3D) page of the OpenCL Manual (3clc) — yes this is the 3D flavor, we're doing element lookups in 3D image objects and getting floating-point values back. so much range, honestly 🦋

✨ NAME ✨

read_imagef_(3D) — do an element lookup in the 3D image object, returning floating-point values. that's it, that's the gig 💅

here's the whole squad of overloads, verbatim:

float4 read_imagef(image3d_t image, sampler_t sampler, int4 coord);

float4 read_imagef(image3d_t image, sampler_t sampler, float4 coord);

float4 read_imagef(image3d_t image, int4 coord);

🌸 DESCRIPTION 🌸

okay so for the forms that take an image3d_t, you use the coordinate (coord.x, coord.y, coord.z) to do an element lookup in the 3D image object specified by image. and coord.w? ignored. not invited. blocked. 🙈

for the forms that take an image3d_array_t, you use coord.xy to do an element lookup in the 2D image identified by coord.z in the 2D image array specified by image. cute little coordinate trick, iykyk ✨

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
  • addressing mode set to CLK_ADDRESS_NONE

no cap, exactly that 💯

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

⚠️ bestie listen. 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. undefined!! we do not play with undefined 💀

values returned by read_imagef for image objects with image_channel_data_type values not specified in the description above are also undefined. don't do it. periodt. 🫶

🎀 NOTES 🎀

general information about the read_image* functions follows, so gather round besties 🌈

the built-in functions defined in this section can only be used with image memory objects. an image memory object can be accessed by specific function calls that read from and/or write to specific locations in the image.

image memory objects that are being read by a kernel should be declared with the accessQualifiers(3clc) qualifier. write_image calls to image memory objects declared with the accessQualifiers(3clc) qualifier will generate a compilation error. image memory objects that are being written to by a kernel should be declared with the accessQualifiers(3clc) qualifier. read_image calls to image memory objects declared with the accessQualifiers(3clc) qualifier will generate a compilation error. read_image and write_image calls to the same image memory object in a kernel are not supported. no, you cannot have both. pick a lane 💅

the read_image calls return a four component floating-point, integer or unsigned integer color value. the color values returned by read_image are identified as x, y, z, w where x refers to the red component, y refers to the green component, z refers to the blue component and w refers to the alpha component. r, g, b, a. main character energy, all four of them 👑

the following table describes the mapping of the number of channels of an image element to the appropriate components in the float4, int4 or uint4 vector data type for the color values returned by read_image{f|i|ui} or supplied to write_image{f|i|ui}. the unmapped components will be set to 0.0 for red, green and blue channels and will be set to 1.0 for the alpha channel.

  • CL_R, CL_Rx — (r, 0.0, 0.0, 1.0)
  • CL_A — (0.0, 0.0, 0.0, a)
  • CL_RG, CL_RGx — (r, g, 0.0, 1.0)
  • CL_RA — (r, 0.0, 0.0, a)
  • CL_RGB, CL_RGBx — (r, g, b, 1.0)
  • CL_RGBA, CL_BGRA, CL_ARGB — (r, g, b, a)
  • CL_INTENSITY — (I, I, I, I)
  • CL_LUMINANCE — (L, L, L, 1.0)

(the channel order is the left column, and the float4, int4 or uint4 components of channel data is the right column — same table, just me being a lil cuter about it 🧚)

a kernel that uses a sampler with the CL_ADDRESS_CLAMP addressing mode with multiple images may result in additional samplers being used internally by an implementation. if the same sampler is used with multiple images called via read_image{f|i|ui}, then it is possible that an implementation may need to allocate an additional sampler to handle the different border color values that may be needed depending on the image formats being used. these implementation allocated samplers will count against the maximum sampler values supported by the device and given by CL_DEVICE_MAX_SAMPLERS. enqueuing a kernel that requires more samplers than the implementation can support will result in a CL_OUT_OF_RESOURCES error being returned. 😭 budget your samplers, bestie, they're not infinite.

📜 SPECIFICATION 📜

OpenCL Specification[1] — yeah, that's the whole section. iconic minimalism. ⭐

👀 SEE ALSO 👀

🫶 AUTHORS 🫶

The Khronos Group 💜

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.

🌟 NOTES (the second one, the receipts) 🌟

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

and that's the whole page, bestie!! 💖 thanks for reading my little read_imagef_(3D) manifesto. this came to you from The Khronos Group, dated 01/14/2021, from the READ_IMAGEF (3D)(3clc) page — slay, bye, go read some images (in 3D, with the right sampler, or the values are undefined and we'd simply pass away) 🎀✨🦋

📦 where this page comes from