Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
sf::BufferStitcher Class Reference

Stitches a buffer from a multiple of writes. More...

#include <BufferStitcher.h>

Public Member Functions

 BufferStitcher ()=default
 
void assign (char *data, size_t sz)
 assign the destination buffer and the size expected.
 
char * getWritePointer () const
 Gets the pointer into the buffer to write next.
 
size_t getWriteSize () const
 Gets the size that still needs to be written/stitched.
 
bool movePosition (size_t sz)
 Moves the write position up for the next write.
 
bool isDone ()
 Gets the status of whether all data has been stitched together. When not initialized.
 

Detailed Description

Stitches a buffer from a multiple of writes.

Constructor & Destructor Documentation

◆ BufferStitcher()

sf::BufferStitcher::BufferStitcher ( )
default

Member Function Documentation

◆ assign()

void sf::BufferStitcher::assign ( char *  data,
size_t  sz 
)

assign the destination buffer and the size expected.

Parameters
dataPointer to the buffer.
szSize of the buffer.

◆ getWritePointer()

char * sf::BufferStitcher::getWritePointer ( ) const

Gets the pointer into the buffer to write next.

◆ getWriteSize()

size_t sf::BufferStitcher::getWriteSize ( ) const

Gets the size that still needs to be written/stitched.

◆ isDone()

bool sf::BufferStitcher::isDone ( )

Gets the status of whether all data has been stitched together. When not initialized.

Returns
True when all stitching has been done.

◆ movePosition()

bool sf::BufferStitcher::movePosition ( size_t  sz)

Moves the write position up for the next write.

Parameters
sz
Returns
True when

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