Celartem::ExportUtils::VFZExportParam Struct Reference

#include <pxl_imageexport.h>

List of all members.

Public Types
enum	VFZFLAGS { NoInfoBlocks = 64, NoThumbnail = 128 }
Public Member Functions
	VFZExportParam (size_t inLevelToPreserve=5)
Public Attributes
size_t	levelToPreserve
	The level to preserve (0-5).
size_t	flags
	Any combination of VFZFLAGS enumeration values.
const SimpleArray< u8 > *	infoBlocks
	Reserved; must be NULL.
size_t	blockCount
	Reserved; must be 0.

---

Detailed Description

VFZExportParam structure is used with exportAsVFZ function and it customizes the parameter for encoding VFZ files.
Before using this structure, you should zero-clear the whole instance to prevent some errors due to lack of the initialization.

See also:

exportAsVFZ

Exporting Images, VFZ/PFZ Image File Format

Definition at line 35 of file pxl_imageexport.h.

---

Member Enumeration Documentation

enum Celartem::ExportUtils::VFZExportParam::VFZFLAGS

This enumeration values are used with flags field.

Enumerator:

NoInfoBlocks	Not to embed information in VFZ file.
NoThumbnail	No thumbnails in VFZ file.

Definition at line 46 of file pxl_imageexport.h.

---

Constructor & Destructor Documentation

Celartem::ExportUtils::VFZExportParam::VFZExportParam

(

size_t

inLevelToPreserve = 5

)

[inline]

This constructor initializes the structure.

Parameters:

inLevelToPreserve

The level to preserve (0-5). If this value is less than 5, it means the output image is lossy.

Definition at line 64 of file pxl_imageexport.h.

---

Member Data Documentation

size_t Celartem::ExportUtils::VFZExportParam::levelToPreserve

The level to preserve (0-5).

The level to preserve (0-5). If this value is less than 5, it means the output image is lossy.

Definition at line 41 of file pxl_imageexport.h.

size_t Celartem::ExportUtils::VFZExportParam::flags

Any combination of VFZFLAGS enumeration values.

Definition at line 53 of file pxl_imageexport.h.

const SimpleArray<u8>* Celartem::ExportUtils::VFZExportParam::infoBlocks

Reserved; must be NULL.

Definition at line 55 of file pxl_imageexport.h.

size_t Celartem::ExportUtils::VFZExportParam::blockCount

Reserved; must be 0.

Definition at line 56 of file pxl_imageexport.h.

---

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

• pxl_imageexport.h

---

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