Fawkes API  Fawkes Development Version
firevision::FvRawWriter Class Reference

FvRaw Writer implementation. More...

#include <>>

Inheritance diagram for firevision::FvRawWriter:

Classes

struct  FvRawHeader
 FvRaw image file header. More...
 

Public Member Functions

 FvRawWriter ()
 Constructor. More...
 
 FvRawWriter (const char *filename, unsigned int width, unsigned int height)
 Constructor. More...
 
 FvRawWriter (const char *filename, unsigned int width, unsigned int height, colorspace_t colorspace, unsigned char *buffer)
 Constructor. More...
 
virtual ~FvRawWriter ()
 Destructor. More...
 
virtual void set_dimensions (unsigned int width, unsigned int height)
 Set dimensions of image in pixels. More...
 
virtual void set_buffer (colorspace_t cspace, unsigned char *buffer)
 Set image buffer. More...
 
virtual void write ()
 Write to file. More...
 
virtual unsigned char * get_write_buffer ()
 Get write buffer. More...
 
- Public Member Functions inherited from firevision::Writer
 Writer (const char *extension=0)
 Constructor. More...
 
virtual ~Writer ()
 Virtual empty destructor. More...
 
virtual void set_filename (const char *filename)
 Set filename. More...
 

Static Public Attributes

static const unsigned int FILE_IDENTIFIER = 0x17559358
 File identifier for FvRaw images. More...
 

Additional Inherited Members

- Protected Member Functions inherited from firevision::Writer
virtual void set_extension (const char *extension)
 Set the filename extension for file written by this writer. More...
 
- Protected Attributes inherited from firevision::Writer
char * filename
 The complete filename. More...
 
char * basename
 The basename of the file. More...
 
char * extension
 The extension of the file. More...
 
unsigned int width
 The width of the image. More...
 
unsigned int height
 The height of the image. More...
 
colorspace_t cspace
 The colorspace of the image. More...
 
unsigned char * buffer
 The image-buffer. More...
 

Detailed Description

FvRaw Writer implementation.

This class allows for writing FvRaw images to a file.

Author
Tim Niemueller

Definition at line 34 of file fvraw.h.

Constructor & Destructor Documentation

◆ FvRawWriter() [1/3]

◆ FvRawWriter() [2/3]

firevision::FvRawWriter::FvRawWriter ( const char *  filename,
unsigned int  width,
unsigned int  height 
)

◆ FvRawWriter() [3/3]

firevision::FvRawWriter::FvRawWriter ( const char *  filename,
unsigned int  width,
unsigned int  height,
colorspace_t  colorspace,
unsigned char *  buffer 
)

◆ ~FvRawWriter()

firevision::FvRawWriter::~FvRawWriter ( )
virtual

Destructor.

Definition at line 106 of file fvraw.cpp.

Member Function Documentation

◆ get_write_buffer()

unsigned char * firevision::FvRawWriter::get_write_buffer ( )
virtual

Get write buffer.

Returns
write buffer

Definition at line 174 of file fvraw.cpp.

◆ set_buffer()

void firevision::FvRawWriter::set_buffer ( colorspace_t  cspace,
unsigned char *  buffer 
)
virtual

Set image buffer.

Parameters
cspacecolor space of image
bufferbuffer of image

Reimplemented from firevision::Writer.

Definition at line 120 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::colorspace, and firevision::Writer::cspace.

◆ set_dimensions()

void firevision::FvRawWriter::set_dimensions ( unsigned int  width,
unsigned int  height 
)
virtual

Set dimensions of image in pixels.

Parameters
widthwidth of image in pixels
heightheight of image in pixels.

Reimplemented from firevision::Writer.

Definition at line 112 of file fvraw.cpp.

References firevision::Writer::height, firevision::FvRawWriter::FvRawHeader::height, firevision::Writer::width, and firevision::FvRawWriter::FvRawHeader::width.

◆ write()

Member Data Documentation

◆ FILE_IDENTIFIER

const unsigned int firevision::FvRawWriter::FILE_IDENTIFIER = 0x17559358
static

File identifier for FvRaw images.

Definition at line 50 of file fvraw.h.

Referenced by FvRawWriter().


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