ifm3d
ifm3d::Buffer_< TP > Class Template Reference

Public Member Functions

 Buffer_ (std::uint32_t cols, std::uint32_t rows, std::optional< ifm3d::json > metadata=std::nullopt)
 
 Buffer_ (Buffer_< TP > &&)=default
 
Buffer_operator= (Buffer_< TP > &&)=default
 
 Buffer_ (const Buffer_< TP > &)=default
 
Buffer_operator= (const Buffer_< TP > &)=default
 
 Buffer_ (const Buffer &)
 
Buffer_operator= (const Buffer &)
 
void Create (std::uint32_t cols, std::uint32_t rows, ifm3d::buffer_id buffer_id)
 
Buffer_ Clone () const
 Creates a full copy of the array and the underlying data.
 
std::uint32_t Height () const
 
std::uint32_t Width () const
 
std::uint32_t Nchannels () const
 
ifm3d::PixelFormat DataFormat () const
 
ifm3d::json Metadata () const
 
TP * Ptr (std::uint32_t row)
 returns a pointer to the specified Buffer row. More...
 
TP * Ptr (std::uint32_t row, std::uint32_t col)
 Pointer to the Pixel at row,col. More...
 
TP & At (std::size_t index)
 
TP & At (std::uint32_t row, std::uint32_t col)
 
void SetTo (TP val, ifm3d::Buffer &mask)
 
Iterator< TP > begin ()
 
Iterator< TP > end ()
 
- Public Member Functions inherited from ifm3d::Buffer
 Buffer ()
 These are various constructors that form a Buffer. More...
 
 Buffer (std::uint32_t cols, std::uint32_t rows, std::uint32_t nchannel, ifm3d::PixelFormat format, const std::optional< ifm3d::json > &metadata=std::nullopt, ifm3d::buffer_id buffer_id=static_cast< ifm3d::buffer_id >(0))
 
 Buffer (Buffer &&)=default
 
Bufferoperator= (Buffer &&)=default
 
 Buffer (const Buffer &)=default
 
Bufferoperator= (const Buffer &)=default
 
void Create (std::uint32_t cols, std::uint32_t rows, std::uint32_t nchannel, ifm3d::PixelFormat format, ifm3d::buffer_id buffer_id)
 
Buffer Clone () const
 Creates a full copy of the array and the underlying data.
 
std::uint32_t Height () const
 
std::uint32_t Width () const
 
std::uint32_t NumChannels () const
 
ifm3d::PixelFormat DataFormat () const
 
ifm3d::json Metadata () const
 
ifm3d::buffer_id BufferId () const
 
size_t Size () const
 Return the size of the buffer in bytes.
 
template<typename T = std::uint8_t>
T * Ptr (std::uint32_t row)
 returns a pointer to the specified Buffer row. More...
 
template<typename T = std::uint8_t>
T const * Ptr (std::uint32_t row) const
 returns a pointer to the specified Buffer row. More...
 
template<typename T = std::uint8_t>
T * Ptr (std::uint32_t row, std::uint32_t col)
 Pointer to the Pixel at row,col. More...
 
template<typename T = std::uint8_t>
T const * Ptr (std::uint32_t row, std::uint32_t col) const
 Pointer to the Pixel at row,col. More...
 
template<typename T >
T & At (std::size_t index)
 
template<typename T >
T & At (std::uint32_t row, std::uint32_t col)
 
template<typename T >
T const & At (std::size_t index) const
 
template<typename T >
T const & At (std::uint32_t row, std::uint32_t col) const
 
template<typename T >
void SetTo (T val, const ifm3d::Buffer &mask)
 
template<typename T >
Iterator< T > begin ()
 
template<typename T >
Iterator< T > end ()
 

Member Function Documentation

◆ Ptr() [1/2]

template<typename TP >
TP* ifm3d::Buffer_< TP >::Ptr ( std::uint32_t  row)

returns a pointer to the specified Buffer row.

Parameters
rownumber

◆ Ptr() [2/2]

template<typename TP >
TP* ifm3d::Buffer_< TP >::Ptr ( std::uint32_t  row,
std::uint32_t  col 
)

Pointer to the Pixel at row,col.

Parameters
row1st dimension index
col2nd dimension index

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