clCreateSampler/1.0
提供: Tommy6
cl_sampler clCreateSampler (cl_context context, cl_bool normalized_coords, cl_addressing_mode addressing_mode, cl_filter_mode *filter_mode, cl_int *errcode_ret)
サンプラーオブジェクトを作成します。サンプラーオブジェクトがどのように動作するかについてはサンプラー項をご覧ください。
パラメータ
- context
- 有効なOpenCLコンテキストを指定します。
- normalized_coords
- 指定したイメージが正規化座標か(normalized_coords に CL_TRUE)か否か(normalized_coords に CL_FALSE)を指定します。
- addressing_mode
- イメージから読み込みを行う際にイメージの範囲外座標をどのように扱うのかを指定します。CL_ADDRESS_REPEAT、CL_ADDRESS_CLAMP_TO_EDGE、CL_ADDRESS_CLAMP、CL_ADDRESS_NONE を指定できます。
- filtering_mode
- イメージを読み込む際に適用するフィルタの種類を指定します。CL_FILTER_NEAREST、CL_FILTER_LINEAR を指定できます。
- errcode_ret
- 適切なエラーコードを返します。errcode_ret が NULL のとき、エラーコードは返されません。
エラー
サンプラーオブジェクトの作成が成功すると、clCreateSampler は有効な非ゼロのサンプラーオブジェクトを返し errcode_ret に CL_SUCCESS を設定します。そうでない場合は NULL を返して errcode_ret に以下のエラーのうちのひとつを設定します。
- CL_INVALID_CONTEXT - context が有効なOpenCLコンテキストでないとき。
- CL_INVALID_VALUE - addressing_mode、filter_mode、normalized_coords もしくはこれらの組み合わせが有効な値でない時。
- CL_INVALID_OPERATION - context 内に、イメージ機能をサポートするデバイスが存在しない(CL_DEVICE_IMAGE_SUPPORT が CL_FALSE である)とき。
- CL_OUT_OF_HOST_MEMORY - ホスト上でのリソース確保に失敗したとき。
変更記録
脚注
―――― Version 1.0, The OpenCL Specification
より翻訳