clGetPlatformIDs

About

利用可能なOpenCLプラットフォームのリストを取得します。

• Original Reference
  • clGetPlatformIDs

C/C++

cl_int clGetPlatformIDs(cl_uint num_entries,
                        cl_platform_id *platforms,
                        cl_uint *num_platforms)

C#

int clGetPlatformIDs (uint num_entries,
                      IntPtr[] platforms,
                      out uint num_platforms);

Args

• num_entries
  • platforms に出力するOpenCLプラットフォームの数を指定します。platforms が NULL でないとき、0より大きい値である必要があります。
• platforms
  • OpenCLプラットフォームの出力先となるポインタのリストを指定します。NULL のとき、この引数は無視されます。
• num_platforms
  • 利用可能なOpenCLプラットフォーム数の出力先を指定します。NULL のとき、この引数は無視されます。

Return

実行に成功したとき、CL_SUCCESS を返します。それ以外のとき、次のうち1つのエラーを返します。

• CL_INVALID_VALUE
  • num_entries が 0 で、かつ、platforms が NULL でないとき。または、num_platforms と platforms が NULL のとき。
• CL_OUT_OF_HOST_MEMORY
  • ホスト上でリソースの確保、割り当てに失敗したとき。