clSetCommandQueueProperty

OpenCL > OpenCLマニュアル > OpenCLランタイム > OpenCLランタイムAPI > コマンドキュー > clSetCommandQueueProperty

cl_int clSetCommandQueueProperty (cl_command_queue command_queue, cl_command_queue_properties properties, cl_bool enable, cl_command_queue_properties *old_properties)

コマンドキューのプロパティの有効・無効を設定します。

パラメータ

command_queue

コマンドキューを指定します。

properties

コマンドキューに適用する新しいプロパティを指定します。有効な値は以下のとおりです。

コマンドキュープロパティ	解説
CL_QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE	このコマンドキューに挿入されるコマンドがインオーダーで実行されるのかアウトオブオーダーで実行されるのかを決定します。このプロパティを設定すると、コマンドキュー内のコマンドはアウトオブオーダーで実行されます。そうでないときはインオーダーで実行されます。
CL_QUEUE_PROFILING_ENABLE	コマンドキュー内のコマンドのプロファイリングを有効にするか無効にするかを決定します。このプロパティを設定すると、コマンドのプロファイリングが有効になります。そうでないときは無効になります。

enable

properties で指定した値を有効にする（CL_TRUE で有効）のか無効にする（CL_FALSE で無効）のか決定します。プロパティの値は上の表のとおりです。

old_properties

clSetCommandQueueProperty で変更される前のコマンドキュープロパティを返します。NULL の場合は無視されます。

エラー

コマンドキューの更新に成功した場合、clSetCommandQueueProperty は CL_SUCCESS を返します。そうでない場合は以下のエラーのうちひとつを返します。

• CL_INVALID_COMMAND_QUEUE - command_queue が有効なコマンドキューでないとき。
• CL_INVALID_VALUE - properties に指定した値が有効なものでないとき。
• CL_INVALID_QUEUE_PROPERTIES - properties に指定した値が、有効であるもののデバイスがサポートしていないとき。

変更記録

• OpenCL 1.1
  • サポート対象から除外

脚注

―――― Version 1.0, The OpenCL Specification より翻訳