CLBufferRead

OpenCL バッファを配列に読み込んで読まれた要素の数を返します。

uint  CLBufferRead(
  int          buffer,                   // OpenCL バッファハンドル
  const void&  data[],                   // 値の配列
  uint         buffer_offset=0,           // OpenCL バッファ内のバイト単位のオフセット(デフォルトで 0)
  uint         data_offset=0,             // OpenCL バッファ内の要素数でのオフセット(デフォルトで 0)
  uint        data_count=WHOLE_ARRAY     // バッファから読まれる値の数(デフォルトではバッファ全体)
  );

パラメータ

buffer

[in]  OpenCL バッファハンドル

data[]

[in]  OpenCL バッファから値を受け取る配列。参照で引き渡されます。

buffer_offset

[in]  OpenCL バッファ内のバイト単位での読み込みが始まるオフセット。デフォルトでは読み込みはバッファの一番初めから始まります。

data_offset

[in]  OpenCLのバッファの値を書き込むための最初の配列要素のインデックス。デフォルトでは、配列への読み込み値の書き込みはゼロインデックスから始まります。

data_count

[in]  読まれる値の数。デフォルトでは OpenCL バファ全体が読まれます。

戻り値

読まれた要素の数。エラーの場合 0 。エラー情報を取得するには、GetLastError() 関数が呼ばれます。

注意事項

1 次元配列では OpenCL バッファへの書き入れが始まる要素の番号はAS_SERIES フラグを考慮して計算されます。

2 次元以上の配列は1 次元として提示されます。この場合 data_offset は、1 次元目の要素の数ではなく、抜かされるべき要素の数です。