roviz  0.7
Code Documentation of roviz
Public Member Functions | List of all members
ImageMutable Class Reference

The mutable version Image. More...

#include <image_m.h>

Inheritance diagram for ImageMutable:
Inheritance graph
Collaboration diagram for ImageMutable:
Collaboration graph

Public Member Functions

 ImageMutable (int w, int h, enum Format f, std::initializer_list< SourceID > sources={})
 Constructs an empty image with the given size. More...
 
unsigned char * data (void)
 
- Public Member Functions inherited from Image
 Image (const StreamObject &base)
 Converts a StreamObject to an Image. More...
 
 Image (std::initializer_list< SourceID > sources={})
 Standard constructor. More...
 
int width (void) const
 
int height (void) const
 
enum Format format (void) const
 
int bitsPerPixel (void) const
 
int bytesPerPixel (void) const
 
int dataLength (void) const
 
const unsigned char * data (void) const
 
- Public Member Functions inherited from StreamObject
SourceID id (void) const
 Get the SourceID of the object. More...
 

Additional Inherited Members

- Public Types inherited from Image
enum  Format {
  NoFormat, RGB555, RGB888, Gray8,
  YUV422, YUV422_Flipped, BGR_CV
}
 Enum of all supported image formats.
 
- Static Public Member Functions inherited from Image
static StreamWidgetinitWidget (OutputPrivate *out)
 initWidget Returns a ImageWidget to display the image More...
 
- Protected Member Functions inherited from Image
 Image (bool do_init, std::initializer_list< SourceID > sources)
 
- Protected Member Functions inherited from StreamObject
void initSources (std::initializer_list< SourceID > sources={})
 
- Protected Attributes inherited from Image
ImagePrivate_this
 
- Protected Attributes inherited from StreamObject
std::shared_ptr< StreamObjectPrivate_this_base
 

Detailed Description

The mutable version Image.

You can manipulate the image data in this class, but it will be always converted to the non-mutable version before it is sent to an item.

See also
Image

Constructor & Destructor Documentation

◆ ImageMutable()

ImageMutable::ImageMutable ( int  w,
int  h,
enum Format  f,
std::initializer_list< SourceID >  sources = {} 
)

Constructs an empty image with the given size.

Parameters
wWidth of the image
hHeight of the image
fFormat of the image
Here is the call graph for this function:

Member Function Documentation

◆ data()

unsigned char * ImageMutable::data ( void  )
Returns
A pointer to the mutable pixel data

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