OpenPose  1.0.0rc2
OpenPose: A Real-Time Multi-Person Key-Point Detection And Multi-Threading C++ Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
cl::Image1DArray Class Reference

Image interface for arrays of 1D images. More...

#include <cl2.hpp>

Inherits cl::Image.

Public Member Functions

 Image1DArray (const Context &context, cl_mem_flags flags, ImageFormat format, size_type arraySize, size_type width, size_type rowPitch, void *host_ptr=NULL, cl_int *err=NULL)
 
 Image1DArray ()
 
 Image1DArray (const cl_mem &imageArray, bool retainObject=false)
 Constructor from cl_mem - takes ownership. More...
 
Image1DArrayoperator= (const cl_mem &rhs)
 
 Image1DArray (const Image1DArray &img)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
 
Image1DArrayoperator= (const Image1DArray &img)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
 Image1DArray (Image1DArray &&img) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC. More...
 
Image1DArrayoperator= (Image1DArray &&img)
 Move assignment to forward move to the superclass correctly. Required for MSVC. More...
 
- Public Member Functions inherited from cl::Image
template<typename T >
cl_int getImageInfo (cl_image_info name, T *param) const
 Wrapper for clGetImageInfo(). More...
 
template<cl_int name>
detail::param_traits
< detail::cl_image_info, name >
::param_type 
getImageInfo (cl_int *err=NULL) const
 Wrapper for clGetImageInfo() 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...
 
Memoryoperator= (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...
 
Memoryoperator= (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...
 
Memoryoperator= (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_typeoperator() () const
 
cl_typeoperator() ()
 
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::Image
 Image ()
 Default constructor - initializes to NULL. More...
 
 Image (const cl_mem &image, bool retainObject=false)
 Constructor from cl_mem - takes ownership. More...
 
Imageoperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy. More...
 
 Image (const Image &img)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...
 
Imageoperator= (const Image &img)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
 Image (Image &&img) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC. More...
 
Imageoperator= (Image &&img)
 Move assignment to forward move to the superclass correctly. Required for MSVC. More...
 
- 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

Image interface for arrays of 1D images.

Constructor & Destructor Documentation

cl::Image1DArray::Image1DArray ( const Context context,
cl_mem_flags  flags,
ImageFormat  format,
size_type  arraySize,
size_type  width,
size_type  rowPitch,
void *  host_ptr = NULL,
cl_int *  err = NULL 
)
inline
cl::Image1DArray::Image1DArray ( )
inline
cl::Image1DArray::Image1DArray ( const cl_mem &  imageArray,
bool  retainObject = false 
)
inlineexplicit

Constructor from cl_mem - takes ownership.

Parameters
retainObjectwill cause the constructor to retain its cl object. Defaults to false to maintain compatibility with earlier versions. See Memory for further details.
cl::Image1DArray::Image1DArray ( const Image1DArray img)
inline

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

cl::Image1DArray::Image1DArray ( Image1DArray &&  img)
inline

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

Member Function Documentation

Image1DArray& cl::Image1DArray::operator= ( const cl_mem &  rhs)
inline
Image1DArray& cl::Image1DArray::operator= ( const Image1DArray img)
inline

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

Image1DArray& cl::Image1DArray::operator= ( Image1DArray &&  img)
inline

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


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