clGetSamplerInfo/1.0

OpenCL > OpenCLマニュアル > OpenCLランタイム > サンプラーオブジェクト > clGetSamplerInfo/1.0

OpenCL > OpenCL 1.0 > OpenCLマニュアル/1.0 > OpenCLランタイム/1.0 > OpenCLランタイムAPI/1.0 > サンプラーオブジェクト/1.0 > clGetSamplerInfo/1.0

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

取得できる情報

param_name で指定できる情報およびこれに対応して param_value に返される情報を以下の表に示しています。

cl_sapmler_info	戻り値型	解説
CL_SAMPLER_REFERENCE_COUNT	cl_uint	sampler の参照カウントを返します。
CL_SAMPLER_CONTEXT	cl_context	sampler を作成するときに指定したコンテキストを返します。
CL_SAMPLER_NORMALIZED_COORDS	cl_bool	clCreateSampler の normalized_coords 引数に指定した値を返します。
CL_SAMPLER_ADDRESSING_MODE	cl_addressing_mode	clCreateSampler の addressing_mode 引数に指定した値を返します。
CL_SAMPLER_FILTER_MODE	cl_filter_mode	clCreateSampler の filter_mode 引数に指定した値を返します。

エラー

実行が成功した場合、clGetSamplerInfo は CL_SUCCESS を返します。param_name がサポートされている値でない、あるいは、param_value_size で指定されたサイズが上記の表で指定されている戻り値型のサイズより小さくかつ param_value が NULL でないとき、CL_INVALID_VALUE を返します。sampler が有効なサンプラーオブジェクトでないとき、CL_INVALID_SAMPLER を返します。

変更記録

脚注

―――― Version 1.0, The OpenCL Specification より翻訳