関数

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

イメージ座標が
正規化されるかど
うか決定。
（CL_TRUEで正規化、
CL_FALSEで非正規化）

addressing_ mode

イメージから読み
込む際に範囲外イメ
ージ座標が処理され
る方法を指定。以下
の値をとる。

CL_ADDRESS_
MIRRORED_REPEAT

CL_ADDRESS_
REPEAT

CL_ADDRESS_
CLAMP_TO_EDGE

CL_ADDRESS_
CLAMP

CL_ADDRESS_
NONE

filter_mode

イメージから読み
込む際に適用される
フィルター型を指定。
次の値のいずれか
をとる。

CL_FILTER_
NEAREST
CL_FILTER_
LINEAR

errcode_ret

適切なエラーコ
ードを戻す。NULL
の場合はエラーコ
ードは戻らない。

成功した場合 の戻り値

有効な非ゼロ のサンプラーオブ ジェクトを戻し、 errcode_retを CL_SUCCESSに設定。

失敗した場合 のerrcode_retの値

CL_INVALID_ CONTEXT

contextが有効
なコンテキスト
でない場合。

CL_INVALID_ VALUE

addressing_mode,
filter_modeまたは
normalized_coords
か、その組み合わせが
有効でない場合。

CL_INVALID_ OPERATION

contextと関連付
けられたデバイスが
イメージをサポート
しない場合。

CL_OUT_OF_ RESOURCES

デバイス上のOpenCL
実装が必要とするリ
ソース確保に失敗し
た場合。

CL_OUT_OF_ HOST_MEMORY

ホスト上のOpenCL
実装が必要とするリソ
ース確保に失敗した
場合。

関数
cl_int clRetainSampler
(
    cl_sampler sampler
)

 サンプラーの参照カウントをインクリメ
ント。暗黙的リテインをする。

 引数

 成功した場合の戻り値

 CL_SUCCESS

 失敗した場合の戻り値

CL_INVALID_SAMPLER

samplerが有効な
サンプラオブジェク
トでない場合。

CL_OUT_OF_
RESOURCES

デバイス上のOpenCL
実装が必要とするリ
ソース確保に失敗した
場合。

CL_OUT_OF_
HOST_MEMORY

ホスト上のOpenCL
実装が必要とする
リソース確保に失敗
した場合。

関数
cl_int clReleaseSampler (
    cl_sampler sampler
)

 サンプラーの参照カウントをデク
リメント。サンプラーオブジェクトは参
照カウントが0になり、コマンドキュー
に挿入されたサンプラを使うコマンドの
実行が終了すると削除される。

 引数

 成功した場合の戻り値

 CL_SUCCESS

 失敗した場合の戻り値

CL_INVALID_SAMPLER

samplerが有効
なサンプラオブジ
ェクトでない場合。

CL_OUT_OF_
RESOURCES

デバイス上の
OpenCL実装が
必要とするリソー
ス確保に失敗し
た場合。

CL_OUT_OF_
HOST_MEMORY

ホスト上のOpenCL
実装が必要とする
リソース確保に失敗
した場合。

関数

cl_int

clGetSamplerInfo (
    cl_sampler sampler,
    cl_sampler_info param_name,
    size_t param_value_size,
    void *param_value,
    size_t *param_value_size_ret
)

サンプラーオブジェクトについての情報を取得。

引数

sampler

サンプラーを指定。

param_name

取得する情報を指定。

param_value

param_nameに
指定した情報につ
いての値が返される
メモリ空間へのポ
インタ。NULLの場
合は無視。

param_value_ size

param_valueが
指すメモリのサイズ
をバイトで指定。
このサイズは戻り
値型のサイズ以上
となる必要がある。

param_value_ size_ret

param_valueに
コピーされるデータ
の実際のサイズをバ
イトで戻す。NULLの
場合は無視。

成功した場合の戻り値

CL_SUCCESS

失敗した場合の戻り値

CL_INVALID_VALUE

 param_nameが
サポートされている
値でない場合。

param_value_size
で指定されたサイズが
戻り値型のサイズより
小さく、param_value
がNULLでない場合。

CL_INVALID_ SAMPLER

samplerが有効な
サンプラーオブジェ
クトでない場合。

CL_OUT_OF_ RESOURCES

デバイス上の
OpenCL実装が必要
とするリソース
確保に失敗した場合。

CL_OUT_OF_ HOST_MEMORY

ホスト上のOpenCL
実装が必要とする
リソース確保に失敗
した場合。

cl_sampler_
info

戻り値型

param_valueに
戻される情報

CL_SAMPLER_
REFERENCE_
COUNT

cl_uint



samplerの参照
カウントを戻す。


CL_SAMPLER_
CONTEXT

cl_context

samplerを作成
するときに指定し
たコンテキストを戻す。

CL_SAMPLER_
NORMALIZED_
COORDS

cl_bool

samplerと関連付
けられた正規化座
標値を戻す。

CL_SAMPLER_
ADDRESSING_
MODE

cl_addressing_
mode

samplerと関連付
けられたアドレス
モード値を戻す。

CL_SAMPLER_
FILTER_MODE

cl_filter_
mode

samplerと関連付
けられたフィルタ
モード値を戻す。