Celartem::DjVu::DjVuEncoder::ParamsEx Struct Reference

#include <djv_djvuencoder.h>

List of all members.

Public Member Functions
	ParamsEx (DictionaryType inDictionaryType=dtUseSharedDict, size_t inAutoDictFlushFreq=20, EncodeMode inEncoderMode=emAuto, size_t inFgSubsample=12, size_t inFgQuality=75, size_t inBgSubsample=3, size_t inBgQuality=75, size_t inUpsample=1)
void	loadFromProfile (const String &inProfileName)
void	loadFromXmlFile (const String &inXmlFileName)
Public Attributes
DictionaryType	dictionaryType
size_t	autoDictFlushFreq
Params	params

---

Detailed Description

Parameters with extra options.
This structure is used with Profile class.

Definition at line 225 of file djv_djvuencoder.h.

---

Constructor & Destructor Documentation

Celartem::DjVu::DjVuEncoder::ParamsEx::ParamsEx	(	DictionaryType	inDictionaryType = dtUseSharedDict,
		size_t	inAutoDictFlushFreq = 20,
		EncodeMode	inEncoderMode = emAuto,
		size_t	inFgSubsample = 12,
		size_t	inFgQuality = 75,
		size_t	inBgSubsample = 3,
		size_t	inBgQuality = 75,
		size_t	inUpsample = 1
	)			[inline]

Initializes ParamsEx structure.

Definition at line 260 of file djv_djvuencoder.h.

---

Member Function Documentation

void Celartem::DjVu::DjVuEncoder::ParamsEx::loadFromProfile

(

const String &

inProfileName

)

Load configuration from the specified profile.

Parameters:

inProfileName

Name of a profile to load.

void Celartem::DjVu::DjVuEncoder::ParamsEx::loadFromXmlFile

(

const String &

inXmlFileName

)

Load configuration from the specified XML file.

Parameters:

inXmlFileName

File name of a XML file.

---

Member Data Documentation

DictionaryType Celartem::DjVu::DjVuEncoder::ParamsEx::dictionaryType

Determines whether it uses shared dictionary or not. This should be one of DictionaryType enumeration values. If this value is dtNoSharedDict, inAutoDictFlushFreq is ignored.
The default is dtUseSharedDict.

Definition at line 234 of file djv_djvuencoder.h.

Referenced by Celartem::DjVu::DjVuEncoder::create().

size_t Celartem::DjVu::DjVuEncoder::ParamsEx::autoDictFlushFreq

Determines how many pages share a dictionary; in other words, this is the frequency of the flushing the dictionary.
DjVuEncoder instance automatically flushes the dictionary if the number of pages specified by inAutoDictFlushFreq is encoded.
If 0 is specified, the automatic flush feature is disabled and you should call writeOutDictionary manually.
Even with inAutoDictFlushFreq value not equal to 0, you can manually call writeOutDictionary and then the dictionary is flushed immediately regardless of inAutoDictFlushFreq value.

Definition at line 249 of file djv_djvuencoder.h.

Referenced by Celartem::DjVu::DjVuEncoder::create().

Params Celartem::DjVu::DjVuEncoder::ParamsEx::params

Other parameters.
See Params for more information.

Definition at line 255 of file djv_djvuencoder.h.

Referenced by Celartem::DjVu::DjVuEncoder::create().

---

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

• djv_djvuencoder.h

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:27 2008.