Image Component Library (ICL)
Public Member Functions | Private Attributes | List of all members
icl::io::FourCC Class Reference

Wrapper class for fourcc color codes. More...

#include <FourCC.h>

Public Member Functions

 FourCC ()
 create a null FourCC (key = 0) More...
 
 FourCC (icl32s key)
 create a FourCC with given key More...
 
 FourCC (const std::string &key)
 create a fourCC from given string color code (e.g. Y422 or MJPG) More...
 
 FourCC (const char *key)
 create a fourCC from given string color code (cstring style) More...
 
void init (const std::string &key)
 initialization utility method More...
 
FourCCoperator= (icl32s key)
 int-assignment More...
 
FourCCoperator= (const std::string &key)
 std::string-assignment More...
 
std::string asString () const
 convert to string More...
 
icl32s asInt () const
 obtain current key (uint) More...
 
 operator bool ()
 check whether it is null More...
 
 operator int ()
 implicit conversion to int More...
 

Private Attributes

icl32s key
 internally a fourcc is represented by an u-int value More...
 

Detailed Description

Wrapper class for fourcc color codes.

See also
ColorFormatDecoder

Constructor & Destructor Documentation

◆ FourCC() [1/4]

icl::io::FourCC::FourCC ( )
inline

create a null FourCC (key = 0)

◆ FourCC() [2/4]

icl::io::FourCC::FourCC ( icl32s  key)
inline

create a FourCC with given key

◆ FourCC() [3/4]

icl::io::FourCC::FourCC ( const std::string &  key)
inline

create a fourCC from given string color code (e.g. Y422 or MJPG)

◆ FourCC() [4/4]

icl::io::FourCC::FourCC ( const char *  key)
inline

create a fourCC from given string color code (cstring style)

Member Function Documentation

◆ asInt()

icl32s icl::io::FourCC::asInt ( ) const
inline

obtain current key (uint)

◆ asString()

std::string icl::io::FourCC::asString ( ) const
inline

convert to string

◆ init()

void icl::io::FourCC::init ( const std::string &  key)
inline

initialization utility method

◆ operator bool()

icl::io::FourCC::operator bool ( )
inline

check whether it is null

◆ operator int()

icl::io::FourCC::operator int ( )
inline

implicit conversion to int

◆ operator=() [1/2]

FourCC& icl::io::FourCC::operator= ( icl32s  key)
inline

int-assignment

◆ operator=() [2/2]

FourCC& icl::io::FourCC::operator= ( const std::string &  key)
inline

std::string-assignment

Member Data Documentation

◆ key

icl32s icl::io::FourCC::key
private

internally a fourcc is represented by an u-int value


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