clan::ImageImportDescription Class Reference

Image Import Description Class. More...

#include <image_import_description.h>

Public Member Functions

 ImageImportDescription ()
 Constructs a image import description with default values. More...
 
 ~ImageImportDescription ()
 
bool flip_vertical () const
 Returns the flip vertical setting. More...
 
std::function< PixelBuffer(PixelBuffer &)> & func_process ()
 User defined fine control of the pixel buffer. More...
 
bool get_premultiply_alpha () const
 Returns the premultiply alpha setting. More...
 
bool is_cached () const
 Returns if this image should be cached. More...
 
bool is_srgb () const
 Returns the sRGB setting. More...
 
PixelBuffer process (PixelBuffer &image) const
 Process the pixel buffers depending of the chosen settings. More...
 
void set_cached (bool enable)
 Controls if this image can be cached. More...
 
void set_flip_vertical (bool enable)
 Set the flip vertical setting. More...
 
void set_premultiply_alpha (bool enable)
 Set the premultiply alpha setting. More...
 
void set_srgb (bool enable)
 Controls if the image is uploaded as a sRGB texture or not. More...
 

Detailed Description

Image Import Description Class.

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

Constructor & Destructor Documentation

clan::ImageImportDescription::ImageImportDescription ( )

Constructs a image import description with default values.

clan::ImageImportDescription::~ImageImportDescription ( )

Member Function Documentation

bool clan::ImageImportDescription::flip_vertical ( ) const

Returns the flip vertical setting.

std::function<PixelBuffer(PixelBuffer &)>& clan::ImageImportDescription::func_process ( )

User defined fine control of the pixel buffer.

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

PixelBuffer func_process(PixelBuffer &input)

bool clan::ImageImportDescription::get_premultiply_alpha ( ) const

Returns the premultiply alpha setting.

bool clan::ImageImportDescription::is_cached ( ) const

Returns if this image should be cached.

bool clan::ImageImportDescription::is_srgb ( ) const

Returns the sRGB setting.

PixelBuffer clan::ImageImportDescription::process ( 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 clan::ImageImportDescription::set_cached ( bool  enable)

Controls if this image can be cached.

(This defaults to true)

void clan::ImageImportDescription::set_flip_vertical ( bool  enable)

Set the flip vertical setting.

(This defaults to off)

void clan::ImageImportDescription::set_premultiply_alpha ( bool  enable)

Set the premultiply alpha setting.

(This defaults to off)

void clan::ImageImportDescription::set_srgb ( bool  enable)

Controls if the image is uploaded as a sRGB texture or not.

(This defaults to off)


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