clRetainMemObject

OpenCL > OpenCLマニュアル > OpenCLランタイム > OpenCLランタイムAPI > メモリオブジェクト > clRetainMemObject

cl_int clRetainMemObject (cl_mem memobj)

-1.1() : OpenCL 1.1で削除

+1.1() : OpenCL 1.1で追加

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

パラメータ

memobj

対象となるメモリオブジェクトを指定します。

解説

clCreateBuffer+1.1(、clCreateSubBuffer)、clCreateImage{2D|3D} は暗黙的にリテインを行います。+1.1(clCreateSubBuffer は、サブバッファオブジェクトもしくはイメージオブジェクトを作成するのに使用したメモリオブジェクトの暗黙的なリテインも行います。)

エラー

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

• CL_INVALID_MEM_OBJECT - memobj が有効なメモリオブジェクト（バッファオブジェクトもしくはイメージオブジェクト）でないとき。
• +1.1(CL_OUT_OF_RESOURCES - デバイス上でのリソース確保に失敗したとき。)
• +1.1(CL_OUT_OF_HOST_MEMORY - ホスト上でのリソース確保に失敗したとき。)

変更記録

脚注

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