A class that specifies common settings for image formats.
More...
#include <omImageFormatSettings.h>
A class that specifies common settings for image formats.
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.
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.
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.
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: