JpgImageEncoder Class Reference

Converts image type ImageType::JPG. More...

#include <ImageEncoder.h>

Collaboration diagram for JpgImageEncoder:

Public Member Functions
	JpgImageEncoder ()
	Construct a new JPG Image Encoder object.
void	SetQuality (int quality)
	Set quality.
int	GetQuality () const
	Provides quality.
void	SetProgressive (bool isOn)
	Set the Progressive Feature A progressive JPEG image is encoded differently than a standard or baseline JPEG image.
bool	GetProgressive () const
	Provides Progressive Feature.
void	SetOptimize (bool isOn)
	Set the Optimize Feature.
bool	GetOptimize () const
	Provides Optimize Feature.
void	Accept (ImageEncoderVisitor &visitor) const final
	Allow visitor to visit concrete type of encoder.
std::vector< uint8_t >	Encode (const RawImage &raw) const final
	Saves given RawImage as formatted image.

Static Public Member Functions
static std::shared_ptr< ImageEncoder >	Create (ImageType type)
	Create concrete default encoder for given type.

Detailed Description

Converts image type ImageType::JPG.

Constructor & Destructor Documentation

JpgImageEncoder()

JpgImageEncoder ( )

inline

Construct a new JPG Image Encoder object.

• Default quality is 95
• progressive feature is off
• optimize feature is off

References SetOptimize(), SetProgressive(), and SetQuality().

Here is the call graph for this function:

Member Function Documentation

Accept()

void Accept ( ImageEncoderVisitor & visitor ) const

inlinefinalvirtual

Allow visitor to visit concrete type of encoder.

Parameters

visitor

ImageEncoderVisitor to call

Implements ImageEncoder.

Create()

std::shared_ptr< ImageEncoder > Create ( ImageType type )

inlinestaticinherited

Create concrete default encoder for given type.

Parameters

type

ImageType

Exceptions

EnrollmentException

when image type is unknown

Returns

ImageEncoder

References ImageType::BMP, ImageType::IRAW, ImageType::JPG, ImageType::JPG2000, ImageType::PNG, ImageType::TIFF, ImageException::UNKNOWN_IMAGE, ImageType::WEBP, and ImageType::WSQ.

Referenced by Image::Decode(), and ImageFileSaver::Save().

Here is the caller graph for this function:

Encode()

std::vector< uint8_t > Encode ( const RawImage & raw ) const

inlinefinalvirtualinherited

Saves given RawImage as formatted image.

Parameters

raw

RawImage

Returns

encoded image

Exceptions

ImageException	when it is not possible to encode image
InvalidImageArgumentException	when image is empty

Implements ImageEncoder.

GetOptimize()

bool GetOptimize ( ) const

inline

Provides Optimize Feature.

Returns

true when optimize Feature is on

false when optimize Feature is off

GetProgressive()

bool GetProgressive ( ) const

inline

Provides Progressive Feature.

Returns

true when progressive Feature is on

false when progressive Feature is off

GetQuality()

int GetQuality ( ) const

inline

Provides quality.

Returns

quality

SetOptimize()

void SetOptimize ( bool isOn )

inline

Set the Optimize Feature.

Parameters

isOn	when true the feature is enabled

Referenced by JpgImageEncoder().

Here is the caller graph for this function:

SetProgressive()

void SetProgressive ( bool isOn )

inline

Set the Progressive Feature A progressive JPEG image is encoded differently than a standard or baseline JPEG image.

It loads in successive waves until a clear picture is formed. This can improve a website's performance as the images seems to be loading faster.

Parameters

isOn	when true the feature is enabled

Referenced by JpgImageEncoder().

Here is the caller graph for this function:

SetQuality()

void SetQuality ( int quality )

inline

Set quality.

Parameters

quality

from 0 to 100 (the higher is the better).

Exceptions

EnrollmentInvalidArgumentException

when quality is not in range

Referenced by JpgImageEncoder().

Here is the caller graph for this function:

---

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

• Image/ImageEncoder.h