関数

cl_int

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

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

引数

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

成功した場合の戻り値

CL_SUCCESS

失敗した場合の戻り値

CL_INVALID_ VALUE

num_entriesが0のときで
platforms引数がNULLでな
いとき。または両方がNULLのとき。

CL_OUT_OF_ HOST_MEMORY

ホスト上のOpenCLの実装
システムがリソースの確保に失敗した場合。

関数

cl_int

clGetPlatformInfo (
    cl_platform_id platform,
    cl_platform_info param_name,
    size_t param_value_size,
    void *param_value,
    size_t *param_value_size_ret
)

OpenCLプラットフォームについてユーザーが指定した 情報を取得します。

引数

platform

clGetPlatformIDsで取得
したプラットフォームIDまたは
NULL値。platform引数がNULL
の場合のふるまいは実装システム
に依存します。

param_name

クエリーするプラットフォーム
の情報を識別する列挙定数です。
定数は以下のテーブルに掲載し
ています。

param_value

param_nameで指定した
データのための記憶域のポインタ
です。

param_value_size

param_valueが指すメモリ
のサイズ（バイトで表す）。

param_value_size_ret

param_valueでクエリー
したデータの実際のサイズです。
param_value_size_retが
NULL値のときは無視されます。

成功した場合の戻り値

CL_SUCCESS

失敗した場合の戻り値

CL_INVALID_ PLATFORM

platformが有効なプラット
フォームでないとき。

CL_INVALID_ VALUE

param_nameがサポートされ
る値でないときか、
param_value_size引数で
指定したバイトで表すサイズ
が戻り値の型を下回るときで、
param_valueがNULL値でないとき。

CL_OUT_OF_ HOST_MEMORY

ホストのOpenCL実装が要求
するリソースの割当に失敗した場合。

cl_platform_ info

戻り値の型 

詳細


CL_PLATFORM_ PROFILE

char[]

実装システムがサポートする
OpenCLプロファイル名を文字
列で戻します。戻される名称は
以下のうちのひとつです。

FULL_PROFILE：
実装がOpenCLの仕様をサポートする場合
（コア仕様として定義されている
機能で、拡張機能のサポートは必要としません。）

EMBEDDED_PROFILE：
OpenCL組み込みプロファイル
をサポートする場合。組み込み
プロファイルは、各バージョン
のOpenCLサブセット
（部分集合）として定義されます。

CL_PLATFORM_ VERSION 

char[] 

実装システムがサポートする
OpenCLのバージョンを次の
形式で戻します。

OpenCL<space>
<major_version.minor_version>
<space>
<platform-specific information>

CL_PLATFORM_ NAME 

char[] 

プラットフォーム名の文字列。

CL_PLATFORM_ VENDOR 

char[] 

プラットフォームベンダ
名の文字列。

CL_PLATFORM_ EXTENSIONS

char[] 

プラットフォームがサポート
する拡張機能名をスペース区
切りのリスト形式文字列で戻
します。（拡張機能名にはス
ペースは含まれません）。