IDSpeakIPL  v1.9.1
peak::ipl::PixelRow Class Reference

Represents the values for a horizontal line of pixels in an image. More...

#include <peak_ipl/types/peak_ipl_pixel_line.hpp>

Inheritance diagram for peak::ipl::PixelRow:
peak::ipl::PixelLine

Public Member Functions

 PixelRow ()=delete
 
 PixelRow (const Image &image, size_t row)
 
 ~PixelRow () override=default
 
 PixelRow (const PixelRow &other)=default
 
PixelRow & operator= (const PixelRow &other)=default
 
 PixelRow (PixelRow &&other)=default
 
PixelRow & operator= (PixelRow &&other)=default
 
- Public Member Functions inherited from peak::ipl::PixelLine
 PixelLine ()=delete
 
 PixelLine (const Image &image, peak::ipl::Orientation orientation, size_t offset)
 Constructor. More...
 
virtual ~PixelLine ()
 Destructor for the PixelLine instance. More...
 
 PixelLine (const PixelLine &other)
 Copy Constructor for a new PixelLine instance. More...
 
PixelLine & operator= (const PixelLine &other)
 Copy assigment for PixelLine instance. More...
 
 PixelLine (PixelLine &&other) noexcept
 Move constructor for PixelLine instance. More...
 
PixelLine & operator= (PixelLine &&other) noexcept
 Move assignment for PixelLine instance. More...
 
PEAK_IPL_NO_DISCARD peak::ipl::PixelFormatName PixelFormatName () const
 Returns the pixel format of the given pixel line. More...
 
PEAK_IPL_NO_DISCARD peak::ipl::Orientation Orientation () const
 Returns the orientation of the given pixel line. More...
 
PEAK_IPL_NO_DISCARD size_t Offset () const
 Returns the offset of the given pixel line. (Vertical: Left - Horizontal: Top). More...
 
PEAK_IPL_NO_DISCARD std::vector< Channel > Channels () const
 Returns the number of the given pixel line's channels. More...
 

Detailed Description

Represents the values for a horizontal line of pixels in an image.

Constructor & Destructor Documentation

◆ PixelRow() [1/4]

peak::ipl::PixelRow::PixelRow ( )
delete

◆ PixelRow() [2/4]

peak::ipl::PixelRow::PixelRow ( const Image &  image,
size_t  row 
)
inlineexplicit

◆ ~PixelRow()

peak::ipl::PixelRow::~PixelRow ( )
overridedefault

◆ PixelRow() [3/4]

peak::ipl::PixelRow::PixelRow ( const PixelRow &  other)
default

◆ PixelRow() [4/4]

peak::ipl::PixelRow::PixelRow ( PixelRow &&  other)
default

Member Function Documentation

◆ operator=() [1/2]

PixelRow& peak::ipl::PixelRow::operator= ( const PixelRow &  other)
default

◆ operator=() [2/2]

PixelRow& peak::ipl::PixelRow::operator= ( PixelRow &&  other)
default

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