clGetDeviceIDs

About

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

• Original Reference
  • clGetDeviceIDs

C/C++

cl_int clGetDeviceIDs (cl_platform_id platform ,
                       cl_device_type device_type ,
                       cl_uint num_entries ,
                       cl_device_id *devices ,
                       cl_uint *num_devices )

C#

int clGetDeviceIDs (IntPtr platform,
                    uint device_type,
                    uint num_entries,
                    IntPtr[] devices,
                    out uint num_devices)

Args

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

Return

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

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