cl::Context Class Reference

Deprecated APIs for 1.2. More...

#include <cl.hpp>

Inheritance diagram for cl::Context:

Public Member Functions
	~Context ()
	Destructor.
	Context (const VECTOR_CLASS< Device > &devices, cl_context_properties *properties=NULL, void(CL_CALLBACK *notifyFptr)(const char *, const void *, ::size_t, void *)=NULL, void *data=NULL, cl_int *err=NULL)
	Constructs a context including a list of specified devices.
	Context (const Device &device, cl_context_properties *properties=NULL, void(CL_CALLBACK *notifyFptr)(const char *, const void *, ::size_t, void *)=NULL, void *data=NULL, cl_int *err=NULL)
	Context (cl_device_type type, cl_context_properties *properties=NULL, void(CL_CALLBACK *notifyFptr)(const char *, const void *, ::size_t, void *)=NULL, void *data=NULL, cl_int *err=NULL)
	Constructs a context including all or a subset of devices of a specified type.
	Context ()
	Default constructor - initializes to NULL.
	Context (const Context &context)
	Copy constructor.
__CL_EXPLICIT_CONSTRUCTORS	Context (const cl_context &context)
	Constructor from cl_context - takes ownership.
Context &	operator= (const Context &rhs)
	Assignment operator from Context.
Context &	operator= (const cl_context &rhs)
	Assignment operator from cl_context - takes ownership.
template<typename T >
cl_int	getInfo (cl_context_info name, T *param) const
	Wrapper for clGetContextInfo().
template<cl_int name>
detail::param_traits< detail::cl_context_info, name >::param_type	getInfo (cl_int *err=NULL) const
	Wrapper for clGetContextInfo() that returns by value.
cl_int	getSupportedImageFormats (cl_mem_flags flags, cl_mem_object_type type, VECTOR_CLASS< ImageFormat > *formats) const
	Gets a list of supported image formats.
Public Member Functions inherited from cl::detail::Wrapper< cl_context >
	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() ()

Static Public Member Functions
static Context	getDefault (cl_int *err=NULL)
	Returns a singleton context including all devices of CL_DEVICE_TYPE_DEFAULT.

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

Detailed Description

Deprecated APIs for 1.2.

Class interface for cl_context.

Note

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

See also

cl_context

Constructor & Destructor Documentation

~Context()

cl::Context::~Context ( )

inline

Destructor.

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

Context() [1/4]

cl::Context::Context ( const VECTOR_CLASS< Device > &  devices, cl_context_properties *  properties = NULL, void(CL_CALLBACK *notifyFptr)( const char *, const void *, ::size_t, void *)  = NULL, void *  data = NULL, cl_int *  err = NULL  )

inline

Constructs a context including a list of specified devices.

Wraps clCreateContext().

Context() [2/4]

cl::Context::Context ( cl_device_type  type, cl_context_properties *  properties = NULL, void(CL_CALLBACK *notifyFptr)( const char *, const void *, ::size_t, void *)  = NULL, void *  data = NULL, cl_int *  err = NULL  )

inline

Constructs a context including all or a subset of devices of a specified type.

Wraps clCreateContextFromType().

References cl::Platform::get().

Context() [3/4]

cl::Context::Context ( const Context &  context )

inline

Copy constructor.

This calls clRetainContext() on the parameter's cl_context.

Context() [4/4]

__CL_EXPLICIT_CONSTRUCTORS cl::Context::Context ( const cl_context &  context )

inline

Constructor from cl_context - takes ownership.

This effectively transfers ownership of a refcount on the cl_context into the new Context object.

Member Function Documentation

getDefault()

static Context cl::Context::getDefault ( cl_int *  err = NULL )

inlinestatic

Returns a singleton context including all devices of CL_DEVICE_TYPE_DEFAULT.

Note

All calls to this function return the same cl_context as the first.

References Context().

Referenced by cl::Buffer::Buffer(), cl::Buffer::Buffer(), and cl::Device::getDefault().

getSupportedImageFormats()

cl_int cl::Context::getSupportedImageFormats ( cl_mem_flags  flags, cl_mem_object_type  type, VECTOR_CLASS< ImageFormat > *  formats  ) const

inline

Gets a list of supported image formats.

Wraps clGetSupportedImageFormats().

operator=() [1/2]

Context & cl::Context::operator= ( const cl_context &  rhs )

inline

Assignment operator from cl_context - takes ownership.

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

operator=() [2/2]

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

inline

Assignment operator from Context.

This calls clRetainContext() on the parameter and clReleaseContext() on the previous value held by this instance.