cl::Pipe Class Reference

Class interface for Pipe Memory Objects. More...

#include <cl2.hpp>

Inherits cl::Memory.

Public Member Functions
	Pipe (const Context &context, cl_uint packet_size, cl_uint max_packets, cl_int *err=NULL)
	Constructs a Pipe in a specified context. More...
	Pipe (cl_uint packet_size, cl_uint max_packets, cl_int *err=NULL)
	Constructs a Pipe in a the default context. More...
	Pipe ()
	Default constructor - initializes to NULL. More...
	Pipe (const cl_mem &pipe, bool retainObject=false)
	Constructor from cl_mem - takes ownership. More...
Pipe &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy. More...
	Pipe (const Pipe &pipe)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Pipe &	operator= (const Pipe &pipe)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
	Pipe (Pipe &&pipe) CL_HPP_NOEXCEPT_
	Move constructor to forward move to the superclass correctly. Required for MSVC. More...
Pipe &	operator= (Pipe &&pipe)
	Move assignment to forward move to the superclass correctly. Required for MSVC. More...
template<typename T >
cl_int	getInfo (cl_pipe_info name, T *param) const
	Wrapper for clGetMemObjectInfo(). More...
template<cl_int name>
detail::param_traits < detail::cl_pipe_info, name > ::param_type	getInfo (cl_int *err=NULL) const
	Wrapper for clGetMemObjectInfo() that returns by value. More...
Public Member Functions inherited from cl::Memory
	Memory ()
	Default constructor - initializes to NULL. More...
	Memory (const cl_mem &memory, bool retainObject)
	Constructor from cl_mem - takes ownership. More...
Memory &	operator= (const cl_mem &rhs)
	Assignment operator from cl_mem - takes ownership. More...
	Memory (const Memory &mem)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
Memory &	operator= (const Memory &mem)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
	Memory (Memory &&mem) CL_HPP_NOEXCEPT_
	Move constructor to forward move to the superclass correctly. Required for MSVC. More...
Memory &	operator= (Memory &&mem)
	Move assignment to forward move to the superclass correctly. Required for MSVC. More...
template<typename T >
cl_int	getInfo (cl_mem_info name, T *param) const
	Wrapper for clGetMemObjectInfo(). More...
template<cl_int name>
detail::param_traits < detail::cl_mem_info, name > ::param_type	getInfo (cl_int *err=NULL) const
	Wrapper for clGetMemObjectInfo() that returns by value. More...
cl_int	setDestructorCallback (void(CL_CALLBACK *pfn_notify)(cl_mem, void *), void *user_data=NULL)
	Registers a callback function to be called when the memory object is no longer needed. More...
Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
	Wrapper ()
	Wrapper (const cl_type &obj, bool retainObject)
	Wrapper (const Wrapper< cl_type > &rhs)
	Wrapper (Wrapper< cl_type > &&rhs) CL_HPP_NOEXCEPT_
	~Wrapper ()
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (Wrapper< cl_type > &&rhs)
Wrapper< cl_type > &	operator= (const cl_type &rhs)
const cl_type &	operator() () const
cl_type &	operator() ()
const cl_type	get () const
cl_type	get ()

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

Detailed Description

Class interface for Pipe Memory Objects.

See Memory for details about copy semantics, etc.

See Also

Memory

Constructor & Destructor Documentation

cl::Pipe::Pipe ( const Context &  context, cl_uint  packet_size, cl_uint  max_packets, cl_int *  err = NULL  )

inline

Constructs a Pipe in a specified context.

Wraps clCreatePipe().

Parameters

context	Context in which to create the pipe.
flags	Bitfield. Only CL_MEM_READ_WRITE and CL_MEM_HOST_NO_ACCESS are valid.
packet_size	Size in bytes of a single packet of the pipe.
max_packets	Number of packets that may be stored in the pipe.

cl::Pipe::Pipe ( cl_uint  packet_size, cl_uint  max_packets, cl_int *  err = NULL  )

inline

Constructs a Pipe in a the default context.

Wraps clCreatePipe().

Parameters

flags	Bitfield. Only CL_MEM_READ_WRITE and CL_MEM_HOST_NO_ACCESS are valid.
packet_size	Size in bytes of a single packet of the pipe.
max_packets	Number of packets that may be stored in the pipe.

cl::Pipe::Pipe ( )

inline

Default constructor - initializes to NULL.

cl::Pipe::Pipe ( const cl_mem &  pipe, bool  retainObject = false  )

inlineexplicit

Constructor from cl_mem - takes ownership.

Parameters

retainObject

will cause the constructor to retain its cl object. Defaults to false to maintain compatibility with earlier versions.

See Memory for further details.

cl::Pipe::Pipe ( const Pipe &  pipe )

inline

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

cl::Pipe::Pipe ( Pipe &&  pipe )

inline

Move constructor to forward move to the superclass correctly. Required for MSVC.

Member Function Documentation

template<typename T >

cl_int cl::Pipe::getInfo ( cl_pipe_info  name, T *  param  ) const

inline

Wrapper for clGetMemObjectInfo().

template<cl_int name>

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

inline

Wrapper for clGetMemObjectInfo() that returns by value.

Pipe& cl::Pipe::operator= ( const cl_mem &  rhs )

inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Pipe& cl::Pipe::operator= ( const Pipe &  pipe )

inline

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

Pipe& cl::Pipe::operator= ( Pipe &&  pipe )

inline

Move assignment to forward move to the superclass correctly. Required for MSVC.

---

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

• /home/travis/build/CMU-Perceptual-Computing-Lab/openpose/include/openpose/gpu/cl2.hpp