clGetProgramBuildInfo
提供: Tommy6
cl_int clGetProgramBuildInfo (cl_program program, cl_device_id device, cl_program_build_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret)
プログラムオブジェクト内の各デバイスについてのビルド情報を取得します。
パラメータ
- program
- 有効なプログラムオブジェクトを指定します。
- device
- ビルド情報を取得するOpenCLデバイスを指定します。program と関連付けられた有効なデバイスでなければなりません。
- param_name
- 取得する情報を指定します。下記の表にある定数からひとつ選んで指定できます。
- param_value
- 下記の表にしたがって param_name に指定した情報についての値が返されるメモリ空間へのポインタです。NULL の場合は無視されます。
- param_value_size
- param_value が指すメモリのサイズをバイトで指定します。このサイズは、下記の表で示されている戻り値型のサイズ以上でなければなりません。
- param_value_size_ret
- param_value にコピーされるデータの実際のサイズをバイトで返します。NULL の場合は無視されます。
取得できる情報
param_name で指定できる情報およびこれに対応して param_value に返される情報を以下の表に示しています。
| cl_program_build_info | 戻り値型 | 解説 |
|---|---|---|
| CL_PROGRAM_BUILD_STATUS | cl_build_status | device についての program のビルド状況を返します。返される値は以下のうちのひとつです。
|
| CL_PROGRAM_BUILD_OPTIONS | char [] | clBuildProgram を呼び出した際に options 引数に指定したビルドオプションを返します。device 用の program のビルド状況が CL_BUILD_NONE のときは、空文字列が返されます。 |
| CL_PROGRAM_BUILD_LOG | char [] | clBuildProgram を呼び出した際のビルドログを返します。device 用の program のビルド状況が CL_BUILD_NONE のときは、空文字列が返されます。 |
エラー
実行が成功した場合、clGetProgramBuildInfo は CL_SUCCESS を返します。そうでない場合は以下のエラーのうちひとつを返します。
- CL_INVALID_PROGRAM - program が有効なプログラムオブジェクトでないとき。
- CL_INVALID_DEVICE - device が program と関連付けられたデバイスではないとき。
- CL_INVALID_VALUE - param_name がサポートされている値でない、あるいは、param_value_size で指定されたサイズが上記の表で指定されている戻り値型のサイズより小さくかつ param_value が NULL でないとき。
- CL_OUT_OF_RESOURCES - デバイス上でのリソース確保に失敗したとき。
- CL_OUT_OF_HOST_MEMORY - ホスト上でのリソース確保に失敗したとき。
変更記録
脚注
