Install Now
Image_Read_and_Write_Functions - Built-in functions to read, write, and query image memory objects. Click
Contents
Copyright
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.
Name
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_imagef1d(3clc) for 1D │ Do an element lookup in the 1D image │
│ │ object with or without a sampler, │
│ │ returning floating-point values. │
├───────────────────────────────────┼───────────────────────────────────────┤
│ read_imagei1d(3clc) 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_imageh1d(3clc) 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(3clc). │
├───────────────────────────────────┼───────────────────────────────────────┤
│ write_image1d(3clc) for 1D │ Write color value to location in the │
│ │ 2D image object. The half type is │
│ │ enabled with cl_khr_fp16(3clc). │
├───────────────────────────────────┼───────────────────────────────────────┤
│ read_imagef2d(3clc) for 2D │ Do an element lookup in the 2D image │
│ │ object with or without a sampler, │
│ │ returning floating-point values. │
├───────────────────────────────────┼───────────────────────────────────────┤
│ read_imagei2d(3clc) 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_imageh2d(3clc) 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(3clc). │
├───────────────────────────────────┼───────────────────────────────────────┤
│ write_image2d(3clc) for 2D │ Write color value to location in the │
│ │ 2D image object. The half type is │
│ │ enabled with cl_khr_fp16(3clc). │
├───────────────────────────────────┼───────────────────────────────────────┤
│ read_imagef3d(3clc) for 3D │ Do an element lookup in the 3D image │
│ │ object with or without a sampler, │
│ │ returning floating-point values. │
├───────────────────────────────────┼───────────────────────────────────────┤
│ read_imagei3d(3clc) 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_imageh3d(3clc) 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(3clc). │
├───────────────────────────────────┼───────────────────────────────────────┤
│ write_image3d(3clc) for 3D │ Write color value to location in the │
│ │ 2D image object. The half type is │
│ │ enabled with cl_khr_fp16(3clc). │
├───────────────────────────────────┼───────────────────────────────────────┤
│ get_image_width(3clc) │ Return the image width in pixels │
├───────────────────────────────────┼───────────────────────────────────────┤
│ get_image_height(3clc) │ Return the image height in pixels. │
├───────────────────────────────────┼───────────────────────────────────────┤
│ get_image_depth(3clc) │ Return the 3D image depth in pixels │
├───────────────────────────────────┼───────────────────────────────────────┤
│ get_image_channel_data_type(3clc) │ Return the image channel data type │
├───────────────────────────────────┼───────────────────────────────────────┤
│ get_image_channel_order(3clc) │ Return the image channel order │
├───────────────────────────────────┼───────────────────────────────────────┤
│ get_image_dim(3clc) │ Return the image dimensions │
├───────────────────────────────────┼───────────────────────────────────────┤
│ get_image_array_size(3clc) │ Return the number of images in an │
│ │ image array │
└───────────────────────────────────┴───────────────────────────────────────┘
Notes
1. OpenCL Specification
page 292, section 6.12.14 - Image Read and Write Functions
The Khronos Group 11/18/2024 IMAGEREAD,WRITE,A(3clc)
See Also
sampler_t(3clc), cl_khr_3d_image_writes(3clc)
Specification
OpenCLSpecification[1]
PNG Icons