clGetPlatformIDs/1.0

OpenCL > OpenCLマニュアル > OpenCLランタイム > OpenCLプラットフォーム > clGetPlatformIDs/1.0

OpenCL > OpenCL 1.0 > OpenCLマニュアル/1.0 > OpenCLランタイム/1.0 > OpenCLプラットフォーム/1.0 > clGetPlatformIDs/1.0

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

有効なOpenCLプラットフォームのリストを取得します。

パラメータ

num_entries

platforms に追加可能な cl_platform_id エントリの数を指定します。platforms が NULL でないのなら、num_entries は0より大きな値でなければなりません。

platforms

OpenCLプラットフォームのリストを返します。platforms 内に返された cl_platform_id の値は、特定のOpenCLプラットフォームを指定するのに用いることができます。platforms が NULL のとき、この引数は無視されます。返されるOpenCLプラットフォームの数は、「num_entries で指定した値」と「有効なOpenCLプラットフォームの数」のうちの値が小さなほうになります。

num_platforms

有効なOpenCLプラットフォームの数を返します。num_platforms が NULL のとき、この引数は無視されます。

エラー

num_entries が0でかつ platforms が NULL でないとき、あるいは num_platforms と platforms の両方が NULL のとき、clGetPlatformIDs は CL_INVALID_VALUE を返します。関数の実行に成功した時は、CL_SUCCESS を返します。

変更記録

脚注

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