Yet Another Robot Platform
No Matches
yarp::sig::FlexImage Class Reference

Image class with user control of representation details. More...

#include <yarp/sig/Image.h>

+ Inheritance diagram for yarp::sig::FlexImage:

Public Member Functions

void setPixelCode (int imgPixelCode)
void setPixelSize (size_t imgPixelSize)
void setQuantum (size_t imgQuantum)
- Public Member Functions inherited from yarp::sig::Image
 Image ()
 Default constructor.
 Image (const Image &alt)
 Copy constructor.
 Image (Image &&other) noexcept
 Move constructor.
Imageoperator= (const Image &alt)
 Assignment operator.
Imageoperator= (Image &&other) noexcept
 Move assignment operator.
 ~Image () override
bool copy (const Image &alt)
 Copy operator.
bool copy (const Image &alt, size_t w, size_t h)
 Scaled copy.
bool move (Image &&alt) noexcept
 move operator.
bool swap (Image &alt)
 swap operator.
size_t width () const
 Gets width of image in pixels.
size_t height () const
 Gets height of image in pixels.
virtual size_t getPixelSize () const
 Gets pixel size in memory in bytes.
virtual int getPixelCode () const
 Gets pixel type identifier.
size_t getRowSize () const
 Size of the underlying image buffer rows.
size_t getQuantum () const
 The size of a row is constrained to be a multiple of the "quantum".
size_t getPadding () const
 Returns the number of padding bytes.
unsigned char * getRow (size_t r)
 Get the address of a the first byte of a row in memory.
const unsigned char * getRow (size_t r) const
 Get the address of a the first byte of a row in memory, const versions.
unsigned char * getPixelAddress (size_t x, size_t y) const
 Get address of a pixel in memory.
bool isPixel (size_t x, size_t y) const
 Check whether a coordinate lies within the image.
void zero ()
 Set all pixels to 0.
void resize (size_t imgWidth, size_t imgHeight)
 Reallocate an image to be of a desired size, throwing away its current contents.
void resize (const Image &alt)
 Reallocate the size of the image to match another, throwing away the actual content of the image.
void setExternal (const void *data, size_t imgWidth, size_t imgHeight)
 Use this to wrap an external image.
unsigned chargetRawImage () const
 Access to the internal image buffer.
size_t getRawImageSize () const
 Access to the internal buffer size information (this is how much memory has been allocated for the image).
bool read (yarp::os::ConnectionReader &connection) override
 Read image from a connection.
bool write (yarp::os::ConnectionWriter &connection) const override
 Write image to a connection.
void setQuantum (size_t imgQuantum)
bool topIsLowIndex () const
void setTopIsLowIndex (bool flag)
 control whether image has origin at top left (default) or bottom left.
char ** getRowArray ()
 Get an array of pointers to the rows of the image.
yarp::os::Type getReadType () const override
- Public Member Functions inherited from yarp::os::Portable
virtual Type getType () const
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
- Public Member Functions inherited from yarp::os::PortWriter
virtual ~PortWriter ()
virtual void onCompletion () const
 This is called when the port has finished all writing operations.
virtual void onCommencement () const
 This is called when the port is about to begin writing operations.
virtual yarp::os::Type getWriteType () const

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Portable
static bool copyPortable (const PortWriter &writer, PortReader &reader)
 Copy one portable to another, via writing and reading.
- Protected Member Functions inherited from yarp::sig::Image
void setPixelCode (int imgPixelCode)
void setPixelSize (size_t imgPixelSize)

Detailed Description

Image class with user control of representation details.

Can be necessary when interfacing with other image types.

Definition at line 374 of file Image.h.

Member Function Documentation

◆ setPixelCode()

void yarp::sig::FlexImage::setPixelCode ( int  imgPixelCode)

Definition at line 377 of file Image.h.

◆ setPixelSize()

void yarp::sig::FlexImage::setPixelSize ( size_t  imgPixelSize)

Definition at line 382 of file Image.h.

◆ setQuantum()

void yarp::sig::FlexImage::setQuantum ( size_t  imgQuantum)

Definition at line 389 of file Image.h.

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