clGetImageInfo/1.0
提供: Tommy6
cl_int clGetImageInfo (cl_mem image, cl_image_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret)
イメージオブジェクトについての情報を取得します。
パラメータ
- image
- イメージオブジェクトを指定します。
- param_name
- 取得する情報を指定します。下記の表にある定数からひとつ選んで指定できます。
- param_value
- 下記の表にしたがって param_name に指定した情報についての値が返されるメモリ空間へのポインタです。NULL の場合は無視されます。
- param_value_size
- param_value が指すメモリのサイズをバイトで指定します。このサイズは、下記の表で示されている戻り値型のサイズ以上でなければなりません。
- param_value_size_ret
- param_value にコピーされるデータの実際のサイズをバイトで返します。NULL の場合は無視されます。
取得できる情報
param_name で指定できる情報およびこれに対応して param_value に返される情報を以下の表に示しています。
| cl_image_info | 戻り値型 | 解説 |
|---|---|---|
| CL_IMAGE_FORAMT | cl_image_format | image を作成する際に clCreateImage{2D|}3D} に指定したイメージ形式記述子を指定します。 |
| CL_IMAGE_ELEMENT_SIZE | size_t | image が指すイメージオブジェクトの画素のサイズを返します。画素は n 個のチャンネルからなります。n の値は cl_image_format で与えられます。 |
| CL_IMAGE_ROW_PITCH | size_t | image が指すイメージオブジェクトの行要素のバイトサイズを返します。 |
| CL_IMAGE_SLICE_PITCH | size_t | image が指す3Dイメージオブジェクトの2Dスライスのバイトサイズを返します。2Dイメージオブジェクトでは、この値は0になります。 |
| CL_IMAGE_WIDTH | size_t | イメージの幅をピクセルで返します。 |
| CL_IMAGE_HEIGHT | size_t | イメージの高さをピクセルで返します。 |
| CL_IMAGE_DEPTH | size_t | イメージの深さをピクセルで返します。2Dイメージオブジェクトでは、depth = 0 になります。 |
エラー
実行が成功した場合、clGetImageInfo は CL_SUCCESS を返します。param_name がサポートされている値でない、あるいは、param_value_size で指定されたサイズが上記の表で指定されている戻り値型のサイズより小さくかつ param_value が NULL でないとき、CL_INVALID_VALUE を返します。image が有効なイメージオブジェクトでないとき、CL_INVALID_MEM_OBJECT を返します。
変更記録
脚注
―――― Version 1.0, The OpenCL Specification
より翻訳
