cl::Sampler Class Reference

Class interface for cl_sampler. More...

#include <cl.hpp>

Inheritance diagram for cl::Sampler:

Public Member Functions
	~Sampler ()
	Destructor.
	Sampler ()
	Default constructor - initializes to NULL.
	Sampler (const Context &context, cl_bool normalized_coords, cl_addressing_mode addressing_mode, cl_filter_mode filter_mode, cl_int *err=NULL)
	Constructs a Sampler in a specified context.
	Sampler (const Sampler &sampler)
	Copy constructor - performs shallow copy.
	Sampler (const cl_sampler &sampler)
	Constructor from cl_sampler - takes ownership.
Sampler &	operator= (const Sampler &rhs)
	Assignment operator from Sampler.
Sampler &	operator= (const cl_sampler &rhs)
	Assignment operator from cl_sampler - takes ownership.
template<typename T >
cl_int	getInfo (cl_sampler_info name, T *param) const
	Wrapper for clGetSamplerInfo().
template<cl_int name>
detail::param_traits< detail::cl_sampler_info, name >::param_type	getInfo (cl_int *err=NULL) const
	Wrapper for clGetSamplerInfo() that returns by value.
Public Member Functions inherited from cl::detail::Wrapper< cl_sampler >
	Wrapper (const cl_type &obj)
	Wrapper (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const cl_type &rhs)
cl_type	operator() () const
cl_type &	operator() ()

Additional Inherited Members
Public Types inherited from cl::detail::Wrapper< cl_sampler >
typedef cl_sampler	cl_type
Protected Member Functions inherited from cl::detail::Wrapper< cl_sampler >
cl_int	retain () const
cl_int	release () const
Protected Attributes inherited from cl::detail::Wrapper< cl_sampler >
cl_type	object_

Detailed Description

Class interface for cl_sampler.

Note

Copies of these objects are shallow, meaning that the copy will refer to the same underlying cl_sampler as the original. For details, see clRetainSampler() and clReleaseSampler().

See also

cl_sampler

Constructor & Destructor Documentation

~Sampler()

cl::Sampler::~Sampler ( )

inline

Destructor.

This calls clReleaseSampler() on the value held by this instance.

Sampler() [1/3]

cl::Sampler::Sampler ( const Context &  context, cl_bool  normalized_coords, cl_addressing_mode  addressing_mode, cl_filter_mode  filter_mode, cl_int *  err = NULL  )

inline

Constructs a Sampler in a specified context.

Wraps clCreateSampler().

Sampler() [2/3]

cl::Sampler::Sampler ( const Sampler &  sampler )

inline

Copy constructor - performs shallow copy.

This calls clRetainSampler() on the parameter's cl_sampler.

Sampler() [3/3]

cl::Sampler::Sampler ( const cl_sampler &  sampler )

inline

Constructor from cl_sampler - takes ownership.

This effectively transfers ownership of a refcount on the cl_sampler into the new Sampler object.

Member Function Documentation

operator=() [1/2]

Sampler & cl::Sampler::operator= ( const cl_sampler &  rhs )

inline

Assignment operator from cl_sampler - takes ownership.

This effectively transfers ownership of a refcount on the rhs and calls clReleaseSampler() on the value previously held by this instance.

operator=() [2/2]

Sampler & cl::Sampler::operator= ( const Sampler &  rhs )

inline

Assignment operator from Sampler.

This calls clRetainSampler() on the parameter and clReleaseSampler() on the previous value held by this instance.