get_image_channel_order

Return the image channel data order.

int get_image_channel_order ( aQual image1d_t  image )
int get_image_channel_order ( aQual image1d_buffer_t  image )
int get_image_channel_order ( aQual image2d_t  image )
int get_image_channel_order ( aQual image3d_t  image )
int get_image_channel_order ( aQual image1d_array_t  image )
int get_image_channel_order ( aQual image2d_array_t  image )
int get_image_channel_order ( aQual image2d_depth_t  image )
int get_image_channel_order ( aQual image2d_array_depth_t  image )

Functions added with MSAA support enabled by extension cl_khr_gl_msaa_sharing:

int get_image_channel_data_order ( image2d_msaa_t  image )
int get_image_channel_data_order ( image2d_array_msaa_t  image )
int get_image_channel_data_order ( image2d_msaa_depth_t  image )
int get_image_channel_data_order ( image2d_array_msaa_depth_t  image )

Description

aQual refers to one of the access qualifiers read_only, write_only, or read_write.

Return the image channel order. Valid values are:


CLK_A
CLK_R
CLK_Rx
CLK_RG
CLK_RGx
CLK_RA
CLK_RGB
CLK_RGBx
CLK_RGBA
CLK_ARGB
CLK_BGRA
CLK_INTENSITY
CLK_LUMINANCE
CLK_ABGR
CLK_DEPTH
CLK_sRGB
CLK_sRGBx
CLK_sRGBA
CLK_sBGRA

Notes

The values returned by get_image_channel_data_type and get_image_channel_order as specified the table above with the CLK_ prefixes correspond to the CL_ prefixes used to describe the image channel order and data type in tables 5.4 (see clCreateSubBuffer) and 5.5 (see clEnqueueMapBuffer). For example, both CL_UNORM_INT8 and CLK_UNORM_INT8 refer to an image channel data type that is an unnormalized unsigned 8-bit integer.

Specification

OpenCL Specification

Also see

Image Functions, cl_khr_gl_msaa_sharing, clCreateSubBuffer, clEnqueueMapBuffer

Copyright © 2007-2015 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.