cl::Sampler Class Reference

Class interface for cl_sampler. More...

#include <cl.hpp>

Inheritance diagram for cl::Sampler:

Collaboration diagram for cl::Sampler:

Public Member Functions
	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.
__CL_EXPLICIT_CONSTRUCTORS	Sampler (const cl_sampler &sampler)
	Constructor from cl_sampler - takes ownership.
Sampler &	operator= (const cl_sampler &rhs)
	Assignment operator from cl_sampler - takes ownership.
	Sampler (const Sampler &sam)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC.
Sampler &	operator= (const Sampler &sam)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC.
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.
	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.
__CL_EXPLICIT_CONSTRUCTORS	Sampler (const cl_sampler &sampler)
	Constructor from cl_sampler - takes ownership.
Sampler &	operator= (const cl_sampler &rhs)
	Assignment operator from cl_sampler - takes ownership.
	Sampler (const Sampler &sam)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC.
Sampler &	operator= (const Sampler &sam)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC.
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 ()
	~Wrapper ()
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
cl_type	operator() () const

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

Definition at line 4504 of file cl.hpp.

Constructor & Destructor Documentation

Sampler() [1/8]

cl::Sampler::Sampler ( )

inline

Default constructor - initializes to NULL.

Definition at line 4508 of file cl.hpp.

Sampler() [2/8]

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().

Definition at line 4514 of file cl.hpp.

Sampler() [3/8]

__CL_EXPLICIT_CONSTRUCTORS 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.

Definition at line 4540 of file cl.hpp.

Sampler() [4/8]

cl::Sampler::Sampler ( const Sampler & sam )

inline

Copy constructor to forward copy to the superclass correctly. Required for MSVC.

Definition at line 4556 of file cl.hpp.

Sampler() [5/8]

cl::Sampler::Sampler ( )

inline

Default constructor - initializes to NULL.

Definition at line 4508 of file cl.hpp.

Sampler() [6/8]

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().

Definition at line 4514 of file cl.hpp.

Sampler() [7/8]

__CL_EXPLICIT_CONSTRUCTORS 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.

Definition at line 4540 of file cl.hpp.

Sampler() [8/8]

cl::Sampler::Sampler ( const Sampler & sam )

inline

Copy constructor to forward copy to the superclass correctly. Required for MSVC.

Definition at line 4556 of file cl.hpp.

Member Function Documentation

getInfo() [1/4]

template<cl_int name>

detail::param_traits< detail::cl_sampler_info, name >::param_type cl::Sampler::getInfo ( cl_int * err = NULL ) const

inline

Wrapper for clGetSamplerInfo() that returns by value.

Definition at line 4595 of file cl.hpp.

getInfo() [2/4]

template<cl_int name>

detail::param_traits< detail::cl_sampler_info, name >::param_type cl::Sampler::getInfo ( cl_int * err = NULL ) const

inline

Wrapper for clGetSamplerInfo() that returns by value.

Definition at line 4595 of file cl.hpp.

getInfo() [3/4]

template<typename T>

cl_int cl::Sampler::getInfo ( cl_sampler_info name, T * param ) const

inline

Wrapper for clGetSamplerInfo().

Definition at line 4585 of file cl.hpp.

getInfo() [4/4]

template<typename T>

cl_int cl::Sampler::getInfo ( cl_sampler_info name, T * param ) const

inline

Wrapper for clGetSamplerInfo().

Definition at line 4585 of file cl.hpp.

operator=() [1/4]

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.

Definition at line 4547 of file cl.hpp.

operator=() [2/4]

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.

Definition at line 4547 of file cl.hpp.

operator=() [3/4]

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

inline

Copy assignment to forward copy to the superclass correctly. Required for MSVC.

Definition at line 4561 of file cl.hpp.

operator=() [4/4]

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

inline

Copy assignment to forward copy to the superclass correctly. Required for MSVC.

Definition at line 4561 of file cl.hpp.

---

The documentation for this class was generated from the following files:

• /build/asl-FBaFQT/asl-0.1.7/debian/tmp/usr/include/ASL/acl/cl.hpp
• /build/asl-FBaFQT/asl-0.1.7/src/acl/cl.hpp