uicore::PixelConverter Class Referenceabstract

Pixel format converter class. More...

#include <pixel_converter.h>

Public Member Functions

virtual void convert (void *output, int output_pitch, TextureFormat output_format, const void *input, int input_pitch, TextureFormat input_format, int width, int height)=0
 Convert some pixel data. More...
 
virtual bool flip_vertical () const =0
 Returns the flip vertical setting. More...
 
virtual float gamma () const =0
 Returns the gamma setting. More...
 
virtual bool input_is_ycrcb () const =0
 Returns the JPEG JFIF YCrCb input setting. More...
 
virtual bool output_is_ycrcb () const =0
 Returns the JPEG JFIF YCrCb output setting. More...
 
virtual bool premultiply_alpha () const =0
 Returns the premultiply alpha setting. More...
 
virtual void set_flip_vertical (bool enable)=0
 Set the flip vertical setting. More...
 
virtual void set_gamma (float gamma)=0
 Set the gamma applied when converting. More...
 
virtual void set_input_is_ycrcb (bool enable)=0
 Converts from JPEG JFIF YCrCb. More...
 
virtual void set_output_is_ycrcb (bool enable)=0
 Converts to JPEG JFIF YCrCb. More...
 
virtual void set_premultiply_alpha (bool enable)=0
 Set the premultiply alpha setting. More...
 
virtual void set_swizzle (const Vec4i &swizzle)=0
 Set the input channel used for each output channel. More...
 
void set_swizzle (int red_source, int green_source, int blue_source, int alpha_source)
 
virtual Vec4i swizzle () const =0
 Returns the input channel used for each output channel. More...
 

Static Public Member Functions

static std::shared_ptr< PixelConvertercreate ()
 Constructs a pixel format converter. More...
 

Detailed Description

Pixel format converter class.

Member Function Documentation

virtual void uicore::PixelConverter::convert ( void *  output,
int  output_pitch,
TextureFormat  output_format,
const void *  input,
int  input_pitch,
TextureFormat  input_format,
int  width,
int  height 
)
pure virtual

Convert some pixel data.

static std::shared_ptr<PixelConverter> uicore::PixelConverter::create ( )
static

Constructs a pixel format converter.

virtual bool uicore::PixelConverter::flip_vertical ( ) const
pure virtual

Returns the flip vertical setting.

virtual float uicore::PixelConverter::gamma ( ) const
pure virtual

Returns the gamma setting.

virtual bool uicore::PixelConverter::input_is_ycrcb ( ) const
pure virtual

Returns the JPEG JFIF YCrCb input setting.

virtual bool uicore::PixelConverter::output_is_ycrcb ( ) const
pure virtual

Returns the JPEG JFIF YCrCb output setting.

virtual bool uicore::PixelConverter::premultiply_alpha ( ) const
pure virtual

Returns the premultiply alpha setting.

virtual void uicore::PixelConverter::set_flip_vertical ( bool  enable)
pure virtual

Set the flip vertical setting.

This defaults to off.

virtual void uicore::PixelConverter::set_gamma ( float  gamma)
pure virtual

Set the gamma applied when converting.

This defaults to 1.0 (off).

virtual void uicore::PixelConverter::set_input_is_ycrcb ( bool  enable)
pure virtual

Converts from JPEG JFIF YCrCb.

virtual void uicore::PixelConverter::set_output_is_ycrcb ( bool  enable)
pure virtual

Converts to JPEG JFIF YCrCb.

virtual void uicore::PixelConverter::set_premultiply_alpha ( bool  enable)
pure virtual

Set the premultiply alpha setting.

This defaults to off.

virtual void uicore::PixelConverter::set_swizzle ( const Vec4i swizzle)
pure virtual

Set the input channel used for each output channel.

Values 0-3 accepted. 0 = red, 1 = green, 2 = blue, 3 = alpha.

void uicore::PixelConverter::set_swizzle ( int  red_source,
int  green_source,
int  blue_source,
int  alpha_source 
)
inline

References set_swizzle().

Referenced by set_swizzle().

virtual Vec4i uicore::PixelConverter::swizzle ( ) const
pure virtual

Returns the input channel used for each output channel.


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