ClanLib  2.3.7
List of all members
CL_ImageImportDescription Class Reference

Image Import Description Class. More...

#include <image_import_description.h>

Public Member Functions

Construction
 CL_ImageImportDescription ()
 Constructs a image import description with default values. More...
 
 ~CL_ImageImportDescription ()
 
Attributes
bool get_premultiply_alpha () const
 Returns the premultiply alpha setting. More...
 
bool flip_vertical () const
 Returns the flip vertical setting. More...
 
Operations
CL_PixelBuffer process (CL_PixelBuffer &image) const
 Process the pixel buffers depending of the chosen settings. More...
 
void set_premultiply_alpha (bool enable)
 Set the premultiply alpha setting. More...
 
void set_flip_vertical (bool enable)
 Set the flip vertical setting. More...
 
Callbacks
CL_Callback_1< CL_PixelBuffer,
CL_PixelBuffer & > & 
func_process ()
 User defined fine control of the pixel buffer. More...
 

Detailed Description

Image Import Description Class.

This class allows you to setup a more advanced description when importing images.

Constructor & Destructor Documentation

CL_ImageImportDescription::CL_ImageImportDescription ( )

Constructs a image import description with default values.

CL_ImageImportDescription::~CL_ImageImportDescription ( )

Member Function Documentation

bool CL_ImageImportDescription::flip_vertical ( ) const

Returns the flip vertical setting.

CL_Callback_1<CL_PixelBuffer, CL_PixelBuffer &>& CL_ImageImportDescription::func_process ( )

User defined fine control of the pixel buffer.

Note, the output maybe different to the input, if desired

CL_PixelBuffer func_process(CL_PixelBuffer &input)

bool CL_ImageImportDescription::get_premultiply_alpha ( ) const

Returns the premultiply alpha setting.

CL_PixelBuffer CL_ImageImportDescription::process ( CL_PixelBuffer image) const

Process the pixel buffers depending of the chosen settings.

Note, the output may point to a different pixel buffer than the input
The input image may be written to.

void CL_ImageImportDescription::set_flip_vertical ( bool  enable)

Set the flip vertical setting.

(This defaults to off)

void CL_ImageImportDescription::set_premultiply_alpha ( bool  enable)

Set the premultiply alpha setting.

(This defaults to off)


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