ifm3d
ifm3d::Buffer_< Tp > Class Template Reference

Public Member Functions

 Buffer_ (const std::uint32_t cols, const 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 (const std::uint32_t cols, const std::uint32_t rows)
 
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::pixel_format dataFormat () const
 
ifm3d::json metadata () const
 
Tp * ptr (const std::uint32_t row)
 returns a pointer to the specified Buffer row. More...
 
Tp * ptr (const std::uint32_t row, const std::uint32_t col)
 Pointer to the Pixel at row,col. More...
 
Tp & at (const std::size_t index)
 
Tp & at (const std::uint32_t row, const std::uint32_t col)
 
void setTo (const 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 (const std::uint32_t cols, const std::uint32_t rows, const std::uint32_t nchannel, ifm3d::pixel_format format, std::optional< ifm3d::json > metadata=std::nullopt)
 
 Buffer (Buffer &&)=default
 
Bufferoperator= (Buffer &&)=default
 
 Buffer (const Buffer &)=default
 
Bufferoperator= (const Buffer &)=default
 
void create (const std::uint32_t cols, const std::uint32_t rows, const std::uint32_t nchannel, ifm3d::pixel_format format)
 
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::pixel_format dataFormat () const
 
ifm3d::json metadata () const
 
size_t size () const
 Return the size of the buffer in bytes.
 
template<typename T = std::uint8_t>
T * ptr (const std::uint32_t row)
 returns a pointer to the specified Buffer row. More...
 
template<typename T = std::uint8_t>
T const * ptr (const std::uint32_t row) const
 returns a pointer to the specified Buffer row. More...
 
template<typename T = std::uint8_t>
T * ptr (const std::uint32_t row, const std::uint32_t col)
 Pointer to the Pixel at row,col. More...
 
template<typename T = std::uint8_t>
T const * ptr (const std::uint32_t row, const std::uint32_t col) const
 Pointer to the Pixel at row,col. More...
 
template<typename T >
T & at (const std::size_t index)
 
template<typename T >
T & at (const std::uint32_t row, const std::uint32_t col)
 
template<typename T >
T const & at (const std::size_t index) const
 
template<typename T >
T const & at (const std::uint32_t row, const std::uint32_t col) const
 
template<typename T >
void setTo (const 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 ( const 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 ( const std::uint32_t  row,
const 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: