NVIDIA DeepStream SDK API Reference

8.0 Release
deepstream::DS3DBuffer Class Reference

Detailed Description

Definition at line 28 of file lidar_feeder.hpp.

Inheritance diagram for deepstream::DS3DBuffer:
Collaboration diagram for deepstream::DS3DBuffer:

Public Types

typedef struct deepstream::Buffer::_Latency Latency
 Unified definition of latency for a buffer. More...
 
using FreeFunction = void(*)(void *)
 Signature of customized function for freeing data in a buffer. More...
 

Public Member Functions

 DS3DBuffer ()
 
 DS3DBuffer (OpaqueBuffer *buffer)
 
 operator bool () const
 If the buffer is null. More...
 
size_t size () const
 Size of the buffer in bytes. More...
 
uint64_t timestamp () const
 Timestamp of the buffer. More...
 
int32_t chunkId (unsigned int batchId) const
 Chunk id of the buffer. More...
 
std::vector< LatencymeasureLatency () const
 Return latency data of the buffer. More...
 
virtual size_t read (std::function< size_t(const void *data, size_t len)> callable)
 Read data from the buffer. More...
 
virtual size_t write (std::function< size_t(void *data, size_t len)> callable)
 Write data to the buffer. More...
 
OpaqueBuffergive ()
 Give up the ownership of this buffer and return the opaque buffer pointer. More...
 
virtual size_t batchSize ()
 get the batch size of the buffer, 1 for un-batched buffer More...
 
virtual Tensorextract (unsigned int batchId)
 create a tensor object with the buffer data More...
 

Static Public Member Functions

static void wrap (Tensor *)
 wrap the tensor to a new buffer More...
 

Protected Attributes

OpaqueBufferbuffer_
 opaque buffer pointer More...
 
std::vector< int > chunk_ids_ = { 0 }
 chunk ids, optional More...
 

Member Typedef Documentation

◆ FreeFunction

using deepstream::Buffer::FreeFunction = void(*)(void*)
inherited

Signature of customized function for freeing data in a buffer.

Definition at line 59 of file buffer.hpp.

◆ Latency

Unified definition of latency for a buffer.

Constructor & Destructor Documentation

◆ DS3DBuffer() [1/2]

deepstream::DS3DBuffer::DS3DBuffer ( )
inline

Definition at line 31 of file lidar_feeder.hpp.

◆ DS3DBuffer() [2/2]

deepstream::DS3DBuffer::DS3DBuffer ( OpaqueBuffer buffer)
inline

Definition at line 32 of file lidar_feeder.hpp.

References deepstream::Buffer::buffer_.

Member Function Documentation

◆ batchSize()

virtual size_t deepstream::Buffer::batchSize ( )
virtualinherited

get the batch size of the buffer, 1 for un-batched buffer

◆ chunkId()

int32_t deepstream::Buffer::chunkId ( unsigned int  batchId) const
inherited

Chunk id of the buffer.

◆ extract()

virtual Tensor* deepstream::Buffer::extract ( unsigned int  batchId)
virtualinherited

create a tensor object with the buffer data

◆ give()

OpaqueBuffer* deepstream::Buffer::give ( )
inherited

Give up the ownership of this buffer and return the opaque buffer pointer.

Referenced by deepstream::EnsembleRender::consume().

◆ measureLatency()

std::vector<Latency> deepstream::Buffer::measureLatency ( ) const
inherited

Return latency data of the buffer.

Referenced by deepstream::NvDsMeasureLatency::handleBuffer().

◆ operator bool()

deepstream::Buffer::operator bool ( ) const
inherited

If the buffer is null.

◆ read()

virtual size_t deepstream::Buffer::read ( std::function< size_t(const void *data, size_t len)>  callable)
virtualinherited

Read data from the buffer.

Parameters
[in]callablecallable provided by the caller to collect data

Reimplemented in deepstream::VideoBuffer.

◆ size()

size_t deepstream::Buffer::size ( ) const
inherited

Size of the buffer in bytes.

◆ timestamp()

uint64_t deepstream::Buffer::timestamp ( ) const
inherited

Timestamp of the buffer.

◆ wrap()

static void deepstream::Buffer::wrap ( Tensor )
staticinherited

wrap the tensor to a new buffer

◆ write()

virtual size_t deepstream::Buffer::write ( std::function< size_t(void *data, size_t len)>  callable)
virtualinherited

Write data to the buffer.

Parameters
[in]callablecallable provided by the caller to inject data

Reimplemented in deepstream::VideoBuffer.

Referenced by deepstream::FileDataSource::read().

Field Documentation

◆ buffer_

OpaqueBuffer* deepstream::Buffer::buffer_
protectedinherited

opaque buffer pointer

Definition at line 164 of file buffer.hpp.

Referenced by DS3DBuffer().

◆ chunk_ids_

std::vector<int> deepstream::Buffer::chunk_ids_ = { 0 }
protectedinherited

chunk ids, optional

Definition at line 166 of file buffer.hpp.


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