Point Cloud Library (PCL): pcl::gpu::DeviceArray< T

#include </__w/1/s/gpu/containers/include/pcl/gpu/containers/device_array.h>

Inheritance diagram for pcl::gpu::DeviceArray< T >:

Public Types
enum	{ elem_size = sizeof(T) }
	Element size. More...

using	type = T
	Element type. More...

Public Member Functions
	DeviceArray ()
	Empty constructor. More...

	DeviceArray (std::size_t size)
	Allocates internal buffer in GPU memory. More...

	DeviceArray (T *ptr, std::size_t size)
	Initializes with user allocated buffer. More...

	DeviceArray (const DeviceArray &other)
	Copy constructor. More...

DeviceArray &	operator= (const DeviceArray &other)
	Assignment operator. More...

void	create (std::size_t size)
	Allocates internal buffer in GPU memory. More...

void	release ()
	Decrements reference counter and releases internal buffer if needed. More...

void	copyTo (DeviceArray &other) const
	Performs data copying. More...

void	upload (const T *host_ptr, std::size_t size)
	Uploads data to internal buffer in GPU memory. More...

void	download (T *host_ptr) const
	Downloads data from internal buffer to CPU memory. More...

template<class A >
void	upload (const std::vector< T, A > &data)
	Uploads data to internal buffer in GPU memory. More...

template<typename A >
void	download (std::vector< T, A > &data) const
	Downloads data from internal buffer to CPU memory. More...

void	swap (DeviceArray &other_arg)
	Performs swap of data pointed with another device array. More...

T *	ptr ()
	Returns pointer for internal buffer in GPU memory. More...

const T *	ptr () const
	Returns const pointer for internal buffer in GPU memory. More...

	operator T* ()
	Returns pointer for internal buffer in GPU memory. More...

	operator const T * () const
	Returns const pointer for internal buffer in GPU memory. More...

std::size_t	size () const
	Returns size in elements. More...

Public Member Functions inherited from pcl::gpu::DeviceMemory
	DeviceMemory ()
	Empty constructor. More...

	~DeviceMemory ()
	Destructor. More...

	DeviceMemory (std::size_t sizeBytes_arg)
	Allocates internal buffer in GPU memory. More...

	DeviceMemory (void *ptr_arg, std::size_t sizeBytes_arg)
	Initializes with user allocated buffer. More...

	DeviceMemory (const DeviceMemory &other_arg)
	Copy constructor. More...

DeviceMemory &	operator= (const DeviceMemory &other_arg)
	Assignment operator. More...

void	create (std::size_t sizeBytes_arg)
	Allocates internal buffer in GPU memory. More...

void	release ()
	Decrements reference counter and releases internal buffer if needed. More...

void	copyTo (DeviceMemory &other) const
	Performs data copying. More...

void	upload (const void *host_ptr_arg, std::size_t sizeBytes_arg)
	Uploads data to internal buffer in GPU memory. More...

void	download (void *host_ptr_arg) const
	Downloads data from internal buffer to CPU memory. More...

void	swap (DeviceMemory &other_arg)
	Performs swap of data pointed with another device memory. More...

template<class T >
T *	ptr ()
	Returns pointer for internal buffer in GPU memory. More...

template<class T >
const T *	ptr () const
	Returns constant pointer for internal buffer in GPU memory. More...

template<class U >
	operator PtrSz< U > () const
	Conversion to PtrSz for passing to kernel functions. More...

bool	empty () const
	Returns true if unallocated otherwise false. More...

std::size_t	sizeBytes () const

Detailed Description

template<class T>
class pcl::gpu::DeviceArray< T >

DeviceArray class

Note: Typed container for GPU memory with reference counting.

Author: Anatoly Baksheev

Definition at line 56 of file device_array.h.

Member Typedef Documentation

◆ type

template<class T >

using pcl::gpu::DeviceArray< T >::type = T

Element type.

Definition at line 60 of file device_array.h.

Member Enumeration Documentation

◆ anonymous enum

template<class T >

anonymous enum

Element size.

Enumerator
elem_size

Definition at line 63 of file device_array.h.

Constructor & Destructor Documentation

◆ DeviceArray() [1/4]

template<class T >

pcl::gpu::DeviceArray< T >::DeviceArray

inline

Empty constructor.

Definition at line 50 of file device_array.hpp.

◆ DeviceArray() [2/4]

template<class T >

pcl::gpu::DeviceArray< T >::DeviceArray ( std::size_t size )

inline

Allocates internal buffer in GPU memory.

Parameters

size	number of elements to allocate

Definition at line 51 of file device_array.hpp.

◆ DeviceArray() [3/4]

template<class T >

pcl::gpu::DeviceArray< T >::DeviceArray	(	T *	ptr,
		std::size_t	size
	)

inline

Initializes with user allocated buffer.

Reference counting is disabled in this case.

Parameters

ptr	pointer to buffer
size	elements number

Definition at line 52 of file device_array.hpp.

◆ DeviceArray() [4/4]

template<class T >

pcl::gpu::DeviceArray< T >::DeviceArray ( const DeviceArray< T > & other )

inline

Copy constructor.

Just increments reference counter.

Definition at line 53 of file device_array.hpp.

Member Function Documentation

◆ copyTo()

template<class T >

void pcl::gpu::DeviceArray< T >::copyTo ( DeviceArray< T > & other ) const

inline

Performs data copying.

If destination size differs it will be reallocated.

Parameters

other destination container

Definition at line 62 of file device_array.hpp.

◆ create()

template<class T >

void pcl::gpu::DeviceArray< T >::create ( std::size_t size )

inline

Allocates internal buffer in GPU memory.

If internal buffer was created before the function recreates it with new size. If new and old sizes are equal it does nothing.

Parameters

size	elements number

Definition at line 57 of file device_array.hpp.

Referenced by pcl::gpu::copyFieldsEx(), pcl::gpu::NeighborIndices::create(), and pcl::gpu::extractEuclideanClusters().

◆ download() [1/2]

template<class T >

template<class A >

void pcl::gpu::DeviceArray< T >::download ( std::vector< T, A > & data ) const

inline

Downloads data from internal buffer to CPU memory.

Parameters

data	host vector to download to

Definition at line 79 of file device_array.hpp.

◆ download() [2/2]

template<class T >

void pcl::gpu::DeviceArray< T >::download ( T * host_ptr ) const

inline

Downloads data from internal buffer to CPU memory.

Parameters

host_ptr pointer to buffer to download

Definition at line 66 of file device_array.hpp.

Referenced by pcl::gpu::kinfuLS::StandaloneMarchingCubes< PointT >::convertTrianglesToMesh(), pcl::gpu::extractEuclideanClusters(), and pcl::gpu::extractLabeledEuclideanClusters().

◆ operator const T *()

template<class T >

pcl::gpu::DeviceArray< T >::operator const T *

inline

Returns const pointer for internal buffer in GPU memory.

Definition at line 72 of file device_array.hpp.

◆ operator T*()

template<class T >

pcl::gpu::DeviceArray< T >::operator T*

inline

Returns pointer for internal buffer in GPU memory.

Definition at line 71 of file device_array.hpp.

◆ operator=()

template<class T >

DeviceArray< T > & pcl::gpu::DeviceArray< T >::operator= ( const DeviceArray< T > & other )

inline

Assignment operator.

Just increments reference counter.

Definition at line 54 of file device_array.hpp.

◆ ptr() [1/2]

template<class T >

const T * pcl::gpu::DeviceArray< T >::ptr

inline

Returns pointer for internal buffer in GPU memory.

Definition at line 75 of file device_array.hpp.

Referenced by pcl::gpu::copyFieldsEx(), pcl::gpu::AsyncCopy< T >::download(), pcl::gpu::extractEuclideanClusters(), pcl::gpu::NeighborIndices::operator PtrStep< int >(), pcl::gpu::TextureBinder::TextureBinder(), and pcl::gpu::AsyncCopy< T >::upload().

◆ ptr() [2/2]

template<class T >

const T* pcl::gpu::DeviceArray< T >::ptr ( ) const

Returns const pointer for internal buffer in GPU memory.

◆ release()

template<class T >

void pcl::gpu::DeviceArray< T >::release

inline

Decrements reference counter and releases internal buffer if needed.

Definition at line 59 of file device_array.hpp.

◆ size()

template<class T >

std::size_t pcl::gpu::DeviceArray< T >::size

inline

Returns size in elements.

Definition at line 73 of file device_array.hpp.

Referenced by pcl::gpu::kinfuLS::StandaloneMarchingCubes< PointT >::convertTrianglesToMesh(), pcl::gpu::copyFieldsEx(), pcl::gpu::NeighborIndices::neighboors_size(), pcl::gpu::AsyncCopy< T >::upload(), and pcl::gpu::NeighborIndices::validate().

◆ swap()

template<class T >

void pcl::gpu::DeviceArray< T >::swap ( DeviceArray< T > & other_arg )

Performs swap of data pointed with another device array.

Parameters

other_arg device array to swap with

Definition at line 69 of file device_array.hpp.

◆ upload() [1/2]

template<class T >

template<class A >

void pcl::gpu::DeviceArray< T >::upload ( const std::vector< T, A > & data )

inline

Uploads data to internal buffer in GPU memory.

It calls create() inside to ensure that intenal buffer size is enough.

Parameters

data	host vector to upload from

Definition at line 78 of file device_array.hpp.

◆ upload() [2/2]

template<class T >

void pcl::gpu::DeviceArray< T >::upload	(	const T *	host_ptr,
		std::size_t	size
	)

inline

Uploads data to internal buffer in GPU memory.

It calls create() inside to ensure that intenal buffer size is enough.

Parameters

host_ptr	pointer to buffer to upload
size	elements number

Definition at line 64 of file device_array.hpp.

Referenced by pcl::gpu::extractEuclideanClusters(), and pcl::gpu::extractLabeledEuclideanClusters().

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

/__w/1/s/gpu/containers/include/pcl/gpu/containers/device_array.h
/__w/1/s/gpu/containers/include/pcl/gpu/containers/impl/device_array.hpp

Public Types

Public Member Functions

Detailed Description

template<class T> class pcl::gpu::DeviceArray< T >

Member Typedef Documentation

◆ type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ DeviceArray() [1/4]

◆ DeviceArray() [2/4]

◆ DeviceArray() [3/4]

◆ DeviceArray() [4/4]

Member Function Documentation

◆ copyTo()

◆ create()

◆ download() [1/2]

◆ download() [2/2]

◆ operator const T *()

◆ operator T*()

◆ operator=()

◆ ptr() [1/2]

◆ ptr() [2/2]

◆ release()

◆ size()

◆ swap()

◆ upload() [1/2]

◆ upload() [2/2]

template<class T>
class pcl::gpu::DeviceArray< T >