Provided by: opencl-1.2-man-doc_1.0~svn22836-1.1_all 
NAME
clGetSupportedImageFormats - Get the list of image formats supported by an OpenCL
implementation.
cl_int clGetSupportedImageFormats(cl_context context, cl_mem_flags flags,
cl_mem_object_type image_type, cl_uint num_entries,
cl_image_format *image_formats,
cl_uint *num_image_formats);
PARAMETERS
context
A valid OpenCL context on which the image object(s) will be created.
flags
A bit-field that is used to specify allocation and usage information about the image
memory object being created and is described in the table below.
┌───────────────────────┬──────────────────────────────────┐
│cl_mem_flags │ Description │
├───────────────────────┼──────────────────────────────────┤
│CL_MEM_READ_WRITE │ This flag specifies that the │
│ │ memory object will be read and │
│ │ written by a kernel. This is the │
│ │ default. │
├───────────────────────┼──────────────────────────────────┤
│CL_MEM_WRITE_ONLY │ This flags specifies that the │
│ │ memory object will be written │
│ │ but not read by a kernel. │
│ │ │
│ │ Reading from a buffer or image │
│ │ object created with │
│ │ CL_MEM_WRITE_ONLY inside a │
│ │ kernel is undefined. │
│ │ │
│ │ CL_MEM_READ_WRITE and │
│ │ CL_MEM_WRITE_ONLY are mutually │
│ │ exclusive. │
├───────────────────────┼──────────────────────────────────┤
│CL_MEM_READ_ONLY │ This flag specifies that the │
│ │ memory object is a read-only │
│ │ memory object when used inside a │
│ │ kernel. │
│ │ │
│ │ Writing to a buffer or image │
│ │ object created with │
│ │ CL_MEM_READ_ONLY inside a kernel │
│ │ is undefined. │
│ │ │
│ │ CL_MEM_READ_WRITE or │
│ │ CL_MEM_WRITE_ONLY and │
│ │ CL_MEM_READ_ONLY are mutually │
│ │ exclusive. │
├───────────────────────┼──────────────────────────────────┤
│CL_MEM_USE_HOST_PTR │ This flag is valid only if │
│ │ host_ptr is not NULL. If │
│ │ specified, it indicates that the │
│ │ application wants the OpenCL │
│ │ implementation to use memory │
│ │ referenced by host_ptr as the │
│ │ storage bits for the memory │
│ │ object. │
│ │ │
│ │ OpenCL implementations are │
│ │ allowed to cache the buffer │
│ │ contents pointed to by host_ptr │
│ │ in device memory. This cached │
│ │ copy can be used when kernels │
│ │ are executed on a device. │
│ │ │
│ │ The result of OpenCL commands │
│ │ that operate on multiple buffer │
│ │ objects created with the same │
│ │ host_ptr or overlapping host │
│ │ regions is considered to be │
│ │ undefined. │
│ │ │
│ │ Refer to the dataTypes(3clc) for │
│ │ host_ptr for memory objects │
│ │ (buffer and images) created │
│ │ using CL_MEM_USE_HOST_PTR. │
├───────────────────────┼──────────────────────────────────┤
│CL_MEM_ALLOC_HOST_PTR │ This flag specifies that the │
│ │ application wants the OpenCL │
│ │ implementation to allocate │
│ │ memory from host accessible │
│ │ memory. │
│ │ │
│ │ CL_MEM_ALLOC_HOST_PTR and │
│ │ CL_MEM_USE_HOST_PTR are mutually │
│ │ exclusive. │
├───────────────────────┼──────────────────────────────────┤
│CL_MEM_COPY_HOST_PTR │ This flag is valid only if │
│ │ host_ptr is not NULL. If │
│ │ specified, it indicates that the │
│ │ application wants the OpenCL │
│ │ implementation to allocate │
│ │ memory for the memory object and │
│ │ copy the data from memory │
│ │ referenced by host_ptr. │
│ │ │
│ │ CL_MEM_COPY_HOST_PTR and │
│ │ CL_MEM_USE_HOST_PTR are mutually │
│ │ exclusive. │
│ │ │
│ │ CL_MEM_COPY_HOST_PTR can be used │
│ │ with CL_MEM_ALLOC_HOST_PTR to │
│ │ initialize the contents of the │
│ │ cl_mem object allocated using │
│ │ host-accessible (e.g. PCIe) │
│ │ memory. │
├───────────────────────┼──────────────────────────────────┤
│CL_MEM_HOST_WRITE_ONLY │ This flag specifies that the │
│ │ host will only write to the │
│ │ memory object (using OpenCL APIs │
│ │ that enqueue a write or a map │
│ │ for write). This can be used to │
│ │ optimize write access from the │
│ │ host (e.g. enable write combined │
│ │ allocations for memory objects │
│ │ for devices that communicate │
│ │ with the host over a system bus │
│ │ such as PCIe). │
├───────────────────────┼──────────────────────────────────┤
│CL_MEM_HOST_READ_ONLY │ This flag specifies that the │
│ │ host will only read the memory │
│ │ object (using OpenCL APIs that │
│ │ enqueue a read or a map for │
│ │ read). │
│ │ │
│ │ CL_MEM_HOST_WRITE_ONLY and │
│ │ CL_MEM_HOST_READ_ONLY are │
│ │ mutually exclusive. │
├───────────────────────┼──────────────────────────────────┤
│CL_MEM_HOST_NO_ACCESS │ This flag specifies that the │
│ │ host will not read or write the │
│ │ memory object. │
│ │ │
│ │ CL_MEM_HOST_WRITE_ONLY or │
│ │ CL_MEM_HOST_READ_ONLY and │
│ │ CL_MEM_HOST_NO_ACCESS are │
│ │ mutually exclusive. │
└───────────────────────┴──────────────────────────────────┘
image_type
Describes the image type and must be either CL_MEM_OBJECT_IMAGE1D,
CL_MEM_OBJECT_IMAGE1D_BUFFER, CL_MEM_OBJECT_IMAGE2D, CL_MEM_OBJECT_IMAGE3D,
CL_MEM_OBJECT_IMAGE1D_ARRAY or CL_MEM_OBJECT_IMAGE2D_ARRAY.
num_entries
Specifies the number of entries that can be returned in the memory location given by
image_formats.
image_formats
A pointer to a memory location where the list of supported image formats are returned.
Each entry describes a cl_image_format(3clc) structure supported by the OpenCL
implementation. If image_formats is NULL, it is ignored.
num_image_formats
The actual number of supported image formats for a specific context and values
specified by flags. If num_image_formats is NULL, it is ignored.
NOTES
clGetSupportedImageFormats can be used to get the list of image formats supported by an
OpenCL implementation when the following information about an image memory object is
specified:
· Context
· Image type - 1D, 2D, or 3D image, 1D image buffer, 1D or 2D image array.
· Image object allocation information
clGetSupportedImageFormats returns a union of image formats supported by all devices in
the context.
For 2D and 3D image objects, the mandated minimum list of image formats that must be
supported by all devices (for reading and writing) that support images is described in the
table below:
┌──────────────────────────────┬────────────────────────────────┬────────────────────────────────────┐
│ image_num_channels │ image_channel_order │ image_channel_data_type │
├──────────────────────────────┼────────────────────────────────┼────────────────────────────────────┤
│ 4 │ CL_RGBA │ CL_UNORM_INT8 │
│ │ │ CL_UNORM_INT16 │
│ │ │ │
│ │ │ CL_SIGNED_INT8 │
│ │ │ CL_SIGNED_INT16 │
│ │ │ CL_SIGNED_INT32 │
│ │ │ │
│ │ │ CL_UNSIGNED_INT8 │
│ │ │ CL_UNSIGNED_INT16 │
│ │ │ CL_UNSIGNED_INT32 │
│ │ │ │
│ │ │ CL_HALF_FLOAT │
│ │ │ CL_FLOAT │
│ │ │ │
├──────────────────────────────┼────────────────────────────────┼────────────────────────────────────┤
│ 4 │ CL_BGRA │ CL_UNORM_INT8 │
└──────────────────────────────┴────────────────────────────────┴────────────────────────────────────┘
If CL_DEVICE_IMAGE_SUPPORT specified in the table of OpenCL Device Queries for
clGetDeviceInfo(3clc) is CL_TRUE, the values assigned to CL_DEVICE_MAX_READ_IMAGE_ARGS,
CL_DEVICE_MAX_WRITE_IMAGE_ARGS, CL_DEVICE_IMAGE2D_MAX_WIDTH, CL_DEVICE_IMAGE2D_MAX_HEIGHT,
CL_DEVICE_IMAGE3D_MAX_WIDTH, CL_DEVICE_IMAGE3D_MAX_HEIGHT, CL_DEVICE_IMAGE3D_MAX_DEPTH,
and CL_DEVICE_MAX_SAMPLERS by the implementation must be greater than or equal to the
minimum values specified in the table of allowed values for param_name for
clGetDeviceInfo(3clc)
ERRORS
Returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns a NULL
value with one of the following errors:
· CL_INVALID_CONTEXT if context is not a valid context.
· CL_INVALID_VALUE if flags or image_type are not valid, or if num_entries is 0 and
image_formats is not NULL.
· CL_OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL
implementation on the device.
· CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the
OpenCL implementation on the host.
SPECIFICATION
OpenCL Specification[1]
SEE ALSO
cl_image_format(3clc)
AUTHORS
The Khronos Group
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.
NOTES
1. OpenCL Specification
page 96, section 5.3.2 - Querying List of Supported Image Formats