clGetContextInfo/1.0
cl_int clGetContextInfo (cl_context context, cl_context_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret)
OpenCLコンテキストについての情報を取得します。
パラメータ
- context
- OpenCLコンテキストを指定します。
- param_name
- 取得する情報を指定します。下記の表にある定数からひとつ選んで指定できます。
- param_value
- 下記の表にしたがって param_name に指定した情報についての値が返されるメモリ空間へのポインタです。NULL の場合は無視されます。
- param_value_size
- param_value が指すメモリのサイズをバイトで指定します。このサイズは、下記の表で示されている戻り値型のサイズ以上でなければなりません。
- param_value_size_ret
- param_value にコピーされるデータの実際のサイズをバイトで返します。NULL の場合は無視されます。
取得できる情報
param_name で指定できる情報およびこれに対応して param_value に返される情報を以下の表に示しています。
| cl_context_info | 戻り値型 | 解説 |
|---|---|---|
| CL_CONTEXT_REFERENCE_COUNT[1] | cl_uint | context の参照カウントを返します |
| CL_CONTEXT_DEVICES | cl_device_id [] | context 内のデバイスの一覧を返します。 |
| CL_CONTEXT_PROPERTIES | cl_context_properties [] | clCreateContext あるいは clCreateContextFromType で指定した properties 引数を返します。
context を作成するのに使用した clCreateContext あるいは clCreateContextFromType への properties 引数が NULL でないとき、実装は properties に指定した値を返さなければなりません。 context を作成するのに使用した clCreateContext あるいは clCreateContextFromType への properties 引数が NULL のとき、param_value_size_ret は0、つまり、プロパティの値は何も返されないか、param_value が指すメモリ内のプロパティ値を0（0は、コンテキストプロパティリストの終端に使用されます）にして返されます。 |
エラー
実行が成功した場合、clGetContextInfo は CL_SUCCESS を返します。context が有効なOpenCLコンテキストでないとき、CL_INVALID_CONTEXT を返します。param_name がサポートされている値でない、あるいは、param_value_size で指定されたサイズが上記の表で指定されている戻り値型のサイズより小さくかつ param_value が NULL でないとき、CL_INVALID_VALUE を返します。
変更記録
脚注
- ↑ 返された参照カウントの値はすぐに古くなるものと考えるべきです。アプリケーションでの一般的な使用には向いていません。この機能はメモリリークを検出するために提供されています。
