clRetainCommandQueue

提供: Tommy6
移動: 案内検索
OpenCL > OpenCLマニュアル > OpenCLランタイム > OpenCLランタイムAPI > コマンドキュー > clRetainCommandQueue

cl_int clRetainCommandQueue[1] (cl_command_queue command_queue)

-1.1() : OpenCL 1.1で削除

+1.1() : OpenCL 1.1で追加

command_queue参照カウントをインクリメントします。

パラメータ

command_queue
対象となるコマンドキューを指定します。

エラー

実行が成功した場合、clRetainCommandQueue は CL_SUCCESS を返します。そうでない場合は以下のエラーのうちひとつを返します。

  • CL_INVALID_COMMAND_QUEUE - command_queue が有効なコマンドキューでないとき。
  • +1.1(CL_OUT_OF_RESOURCES - デバイス上でのリソース確保に失敗したとき。)
  • +1.1(CL_OUT_OF_HOST_MEMORY - ホスト上でのリソース確保に失敗したとき。)

変更記録

脚注

  1. clCreateCommandQueue は暗黙的にリテインを行います。これは、アプリケーションによって渡されたコマンドキューを取得するといった典型的な振る舞いを見せるサードパーティのライブラリなどで有用です。アプリケーションは、ライブラリに知らせることなくコマンドキューを削除できます。リテイン・リリースを関数が行えるようにすることで、ライブラリが利用していたコマンドキューが途中で使えなくなるといった問題を解決できます。


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