To create a sampler object, call the function
const cl_sampler_properties* sampler_properties,
|clCreateSamplerWithProperties is missing before version 2.0.
context must be a valid OpenCL context.
sampler_properties specifies a list of sampler property names and their corresponding values. Each sampler property name is immediately followed by the corresponding desired value. The list is terminated with 0. The list of supported properties is described in the Sampler Properties table. If a supported property and its value is not specified in sampler_properties, its default value will be used. sampler_properties can be
NULLin which case the default values for supported sampler properties will be used.
A boolean value that specifies whether the image coordinates specified are normalized or not.
The default value (i.e. the value used if this property is not
specified in sampler_properties) is
Specifies how out-of-range image coordinates are handled when reading from an image. Valid values are:
The default is
Specifies the type of filter that is applied when reading an image. Valid values are:
The default value is
errcode_ret will return an appropriate error code. If errcode_ret is
NULL, no error code is returned.
clCreateSamplerWithProperties returns a valid non-zero sampler object and
errcode_ret is set to
CL_SUCCESS if the sampler object is created
Otherwise, it returns a
NULL value with one of the following error values
returned in errcode_ret:
CL_INVALID_if context is not a valid context.
CL_INVALID_if the property name in sampler_properties is not a supported property name, if the value specified for a supported property name is not valid, or if the same property name is specified more than once.
CL_INVALID_if images are not supported by any device associated with context (i.e.
CL_DEVICE_specified in the Device Queries table is
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the device.
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the host.
OF_ HOST_ MEMORY
For more information, see the OpenCL Specification
This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.