om::images::base::ImageFormatSettings Class Reference

A class that specifies common settings for image formats. More...

#include <omImageFormatSettings.h>

Public Member Functions
	ImageFormatSettings ()
	Create a default image format settings object. More...
	ImageFormatSettings (Float newCompression)
	Create a default image format settings object that uses the specified compression amount. More...
ImageFormatFlags &	getFlags ()
	Return a reference to an object that contains boolean parameters of the image format setting. More...
const ImageFormatFlags &	getFlags () const
	Return an object that contains boolean parameters of the image format setting. More...
void	setFlags (const ImageFormatFlags &newFlags)
	Set an object that contains boolean parameters of the image format setting. More...
Bool	flagIsSet (ImageFormatFlags::Flag flag) const
	Return whether or not the specified boolan flag is set for this image format setting. More...
Bool	flagsAreSet (const ImageFormatFlags &otherFlags) const
	Return whether or not all of the specified boolan flags are set for this image format setting. More...
void	setFlag (ImageFormatFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan flag is set for this image format setting. More...
Float	getCompression () const
	Return a floating point value between 0 and 1 indicating the amount of compression to use. More...
void	setCompression (Float newCompression)
	Set a value between 0 and 1 indicating the amount of compression to use. More...

Detailed Description

A class that specifies common settings for image formats.

Constructor & Destructor Documentation

om::images::base::ImageFormatSettings::ImageFormatSettings ( )

inline

Create a default image format settings object.

om::images::base::ImageFormatSettings::ImageFormatSettings ( Float  newCompression )

inline

Create a default image format settings object that uses the specified compression amount.

Member Function Documentation

ImageFormatFlags& om::images::base::ImageFormatSettings::getFlags ( )

inline

Return a reference to an object that contains boolean parameters of the image format setting.

const ImageFormatFlags& om::images::base::ImageFormatSettings::getFlags ( ) const

inline

Return an object that contains boolean parameters of the image format setting.

void om::images::base::ImageFormatSettings::setFlags ( const ImageFormatFlags &  newFlags )

inline

Set an object that contains boolean parameters of the image format setting.

Bool om::images::base::ImageFormatSettings::flagIsSet ( ImageFormatFlags::Flag  flag ) const

inline

Return whether or not the specified boolan flag is set for this image format setting.

Bool om::images::base::ImageFormatSettings::flagsAreSet ( const ImageFormatFlags &  otherFlags ) const

inline

Return whether or not all of the specified boolan flags are set for this image format setting.

void om::images::base::ImageFormatSettings::setFlag ( ImageFormatFlags::Flag  flag, Bool  newIsSet = true  )

inline

Set whether or not the specified boolan flag is set for this image format setting.

Float om::images::base::ImageFormatSettings::getCompression ( ) const

inline

Return a floating point value between 0 and 1 indicating the amount of compression to use.

If an image format supports compression, this value will determine the amount of compression that is used. A value of 0 indicates no compression or the lowest amount of compression and a value of 1 indicates that maximum compression is desired. If the image type does not support compression, this value is ignored. The default value is 0, indicating that no compression should be used.

void om::images::base::ImageFormatSettings::setCompression ( Float  newCompression )

inline

Set a value between 0 and 1 indicating the amount of compression to use.

If an image format supports compression, this value will determine the amount of compression that is used. A value of 0 indicates no compression or the lowest amount of compression and a value of 1 indicates that maximum compression is desired. If the image type does not support compression, this value is ignored. The default value is 0, indicating that no compression should be used. The input value is clamped to the range of 0 to 1.

---

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

• omImageFormatSettings.h