clGetCommandQueueInfo/1.0
提供: Tommy6
cl_int clGetCommandQueueInfo[1] (cl_command_queue command_queue, cl_command_queue_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret)
コマンドキューについての情報を取得します。
パラメータ
- command_queue
- コマンドキューを指定します。
- param_name
- 取得する情報を指定します。下記の表にある定数からひとつ選んで指定できます。
- param_value
- 下記の表にしたがって param_name に指定した情報についての値が返されるメモリ空間へのポインタです。NULL の場合は無視されます。
- param_value_size
- param_value が指すメモリのサイズをバイトで指定します。このサイズは、下記の表で示されている戻り値型のサイズ以上でなければなりません。
- param_value_size_ret
- param_value にコピーされるデータの実際のサイズをバイトで返します。NULL の場合は無視されます。
取得できる情報
param_name で指定できる情報およびこれに対応して param_value に返される情報を以下の表に示しています。
| cl_command_queue_info | 戻り値型 | 解説 |
|---|---|---|
| CL_QUEUE_CONTEXT | cl_context | コマンドキューを作成するときに指定したOpenCLコンテキストを返します。 |
| CL_QUEUE_DEVICE | cl_device_id | コマンドキューを作成するときに指定したOpenCLデバイスを返します。 |
| CL_QUEUE_REFERENCE_COUNT[2] | cl_uint | command_queue の参照カウントを返します。 |
| CL_QUEUE_PROPERTIES | cl_command_queue_properties | コマンドキューに現在指定されているプロパティを返します。このプロパティは、clCreateCommandQueue の properties 引数で指定したものです。このプロパティは、clSetCommandQueueProperty で変更できます。 |
エラー
実行が成功した場合、clGetCommandQueueInfo は CL_SUCCESS を返します。そうでない場合は以下のエラーのうちひとつを返します。command_queue が有効なコマンドキューでないとき、param_name がサポートされている値でない、あるいは、param_value_size で指定されたサイズが上記の表で指定されている戻り値型のサイズより小さくかつ param_value が NULL でないとき、CL_INVALID_VALUE を返します。
変更記録
脚注
- ↑ It is possible that a device(s) becomes unavailable after a context and command-queues that use this device(s) have been created and commands have been queued to command-queues. In this case the behavior of OpenCL API calls that use this context (and command-queues) are considered to be implementation-defined. The user callback function, if specified, when the context is created can be used to record appropriate information in the errinfo, private_info arguments passed to the callback function when the device becomes unavailable.
- ↑ 返された参照カウントの値はすぐに古くなるものと考えるべきです。アプリケーションでの一般的な使用には向いていません。この機能はメモリリークを検出するために提供されています。
―――― Version 1.0, The OpenCL Specification
より翻訳
