VideoTools
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Gv::CaptureBufferFormat Class Reference

A descriptor for a v4l pixel format. More...

#include <gvcapturebuffer.h>

Public Types

enum  Type { rgb, yuv, grey }
 

Public Member Functions

 CaptureBufferFormat (unsigned int id_=0, const char *name_="", Type type_=rgb)
 Default constructor for an unusable, un-named rgb format.
 
 CaptureBufferFormat (unsigned int id_, const char *name_, Type type_, const CaptureBufferComponent &, const CaptureBufferComponent &, const CaptureBufferComponent &)
 Constructor for a named format. Use a string literal for the name.
 
bool is_grey () const
 Returns true if grey colour components.
 
bool is_rgb () const
 Returns true if rgb colour components.
 
bool is_yuv () const
 Returns true if yuv colour components.
 
bool is_simple () const
 Returns true for a packed rgb format with 24 bits per pixel.
 
const CaptureBufferComponentcomponent (int c) const
 Returns the c'th colour component descriptor. More...
 
unsigned int id () const
 Returns the id.
 
const char * name () const
 Returns the name.
 
Type type () const
 Returns the type.
 

Detailed Description

A descriptor for a v4l pixel format.

The descriptor, together with a scale structure, allow other classes to extract pixel values from a raw v4l buffer that is laid out in the way described.

Definition at line 218 of file gvcapturebuffer.h.

Member Function Documentation

const Gv::CaptureBufferComponent & Gv::CaptureBufferFormat::component ( int  c) const
inline

Returns the c'th colour component descriptor.

Every format has exactly three components; grey formats have a zero depth for two of them.

Definition at line 621 of file gvcapturebuffer.h.


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