Zivid C++ API  1.4.0+956f554d-12
Defining the Future of 3D Machine Vision
Public Member Functions | List of all members
Zivid::DeviceCloud Class Reference

Point cloud on the Compute device More...

#include <Zivid/DeviceCloud.h>

Public Member Functions

ZIVID_API_EXPORT DeviceCloud ()
 Create an empty device cloud More...
 
ZIVID_API_EXPORT DeviceCloud (const PointCloud &cloud)
 Create a device cloud from a point cloud More...
 
ZIVID_API_EXPORT DeviceCloud (const PointCloud &cloud, ComputeDevice device)
 Create a device cloud from a point cloud on a given Compute device More...
 
ZIVID_API_EXPORT bool isEmpty () const
 Check if the device cloud is empty More...
 
ZIVID_API_EXPORT DeviceCloud clone () const
 Clone the device cloud More...
 
ZIVID_API_EXPORT PointCloud copyToCPU () const
 Copy to the device cloud to a CPU point cloud More...
 
ZIVID_API_EXPORT void lock ()
 Lock the point cloud More...
 
ZIVID_API_EXPORT size_t rows () const
 Get number of rows in point cloud More...
 
ZIVID_API_EXPORT size_t cols () const
 Get number of columns in point cloud More...
 
ZIVID_API_EXPORT void unlock ()
 Unlock the point cloud More...
 
ZIVID_API_EXPORT bool tryLock ()
 Check if a lock can be obtained for the point cloud More...
 
ZIVID_API_EXPORT bool tryLockFor (const std::chrono::milliseconds &duration)
 Check if a lock can be obtained for the point cloud (with a specified timeout) More...
 

Detailed Description

Point cloud on the Compute device

Constructor & Destructor Documentation

◆ DeviceCloud() [1/3]

ZIVID_API_EXPORT Zivid::DeviceCloud::DeviceCloud ( )

Create an empty device cloud

◆ DeviceCloud() [2/3]

ZIVID_API_EXPORT Zivid::DeviceCloud::DeviceCloud ( const PointCloud cloud)
explicit

Create a device cloud from a point cloud

◆ DeviceCloud() [3/3]

ZIVID_API_EXPORT Zivid::DeviceCloud::DeviceCloud ( const PointCloud cloud,
ComputeDevice  device 
)
explicit

Create a device cloud from a point cloud on a given Compute device

Member Function Documentation

◆ clone()

ZIVID_API_EXPORT DeviceCloud Zivid::DeviceCloud::clone ( ) const

Clone the device cloud

◆ cols()

ZIVID_API_EXPORT size_t Zivid::DeviceCloud::cols ( ) const

Get number of columns in point cloud

◆ copyToCPU()

ZIVID_API_EXPORT PointCloud Zivid::DeviceCloud::copyToCPU ( ) const

Copy to the device cloud to a CPU point cloud

◆ isEmpty()

ZIVID_API_EXPORT bool Zivid::DeviceCloud::isEmpty ( ) const

Check if the device cloud is empty

◆ lock()

ZIVID_API_EXPORT void Zivid::DeviceCloud::lock ( )

Lock the point cloud

The point cloud should be locked before elements are manipulated or accessed directly

◆ rows()

ZIVID_API_EXPORT size_t Zivid::DeviceCloud::rows ( ) const

Get number of rows in point cloud

◆ tryLock()

ZIVID_API_EXPORT bool Zivid::DeviceCloud::tryLock ( )

Check if a lock can be obtained for the point cloud

◆ tryLockFor()

ZIVID_API_EXPORT bool Zivid::DeviceCloud::tryLockFor ( const std::chrono::milliseconds &  duration)

Check if a lock can be obtained for the point cloud (with a specified timeout)

◆ unlock()

ZIVID_API_EXPORT void Zivid::DeviceCloud::unlock ( )

Unlock the point cloud


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