[ ]>
Image Read and Write Functions
Image Read, Write, and Query Functions
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
Image Read and Write Functions Built-in functions to read, write, and query image memory objects. Click an item in the table below for details about that function.

##

read_imagef for 1D | Do an element lookup in the 1D image object with or without a sampler, returning floating-point values.
read_image{i|ui} for 1D | Do an element lookup in the 1D image object with or without a sampler, returning unnormalized signed integer and unsigned integer values.
read_imageh for 1D | OPTIONAL function to do an element lookup in the 1D image object with or without a sampler, returning floating-point values. Enabled with cl_khr_fp16.
write_image {f|i|ui|h} for 1D | Write `color` value to location in the 2D image object. The half type is enabled with cl_khr_fp16.
read_imagef for 2D | Do an element lookup in the 2D image object with or without a sampler, returning floating-point values.
read_image{i|ui} for 2D | Do an element lookup in the 2D image object with or without a sampler, returning unnormalized signed integer and unsigned integer values.
read_imageh for 2D | OPTIONAL function to do an element lookup in the 2D image object with or without a sampler, returning floating-point values. Enabled with cl_khr_fp16.
write_image {f|i|ui|h} for 2D | Write `color` value to location in the 2D image object. The half type is enabled with cl_khr_fp16.
read_imagef for 3D | Do an element lookup in the 3D image object with or without a sampler, returning floating-point values.
read_image{i|ui} for 3D | Do an element lookup in the 3D image object with or without a sampler, returning unnormalized signed integer and unsigned integer values.
read_imageh for 3D | OPTIONAL function to do an element lookup in the 3D image object with or without a sampler, returning floating-point values. Enabled with cl_khr_fp16.
write_image {f|i|ui|h} for 3D | Write `color` value to location in the 2D image object. The half type is enabled with cl_khr_fp16.
get_image_width | Return the image width in pixels
get_image_height | Return the image height in pixels.
get_image_depth | Return the 3D image depth in pixels
get_image_channel_data_type | Return the image channel data type
get_image_channel_order | Return the image channel order
get_image_dim | Return the image dimensions
get_image_array_size | Return the number of images in an image array

## Notes

&imageFunctionsInc;

## Specification

OpenCL Specification

## Also see

sampler_t, cl_khr_3d_image_writes

##