「clGetPlatformIDs」の版間の差分

2011年5月10日 (火) 11:15時点における版

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

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 のとき、この引数は無視されます。

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

CL_INVALID_VALUE - num_entries が0でかつ platforms が NULL でないとき。あるいは、num_platforms と platforms の両方が NULL のとき。
CL_OUT_OF_HOST_MEMORY - ホスト上でのリソース確保に失敗したとき。

@@ 12行: / 12行: @@
 :''platforms'' に追加可能な [[cl_platform_id]] エントリの数を指定します。''platforms'' が NULL でないのなら、''num_entries'' は0より大きな値でなければなりません。
 ;platforms
-:[[OpenCLプラットフォーム]]のリストを返します。''platforms'' 内に返された [[cl_platform_id]] の値は、特定のOpenCLプラットフォームを指定するのに用いることができます。''platforms'' が NULL のとき、この引数は無視されます。返されるOpenCLプラットフォームの数は、''num_entries'' で指定した値と有効なOpenCLプラットフォームの数のいずれか小さなほうになります。
+:[[OpenCLプラットフォーム]]のリストを返します。''platforms'' 内に返された [[cl_platform_id]] の値は、特定のOpenCLプラットフォームを指定するのに用いることができます。''platforms'' が NULL のとき、この引数は無視されます。返されるOpenCLプラットフォームの数は、「''num_entries'' で指定した値」と「有効なOpenCLプラットフォームの数」のうちの値が小さなほうになります。
 ;num_platforms
 :有効な[[OpenCLプラットフォーム]]の数を返します。''num_platforms'' が NULL のとき、この引数は無視されます。