Celartem::ExportUtils::JPEG2000ExportParam Struct Reference

#include <pxl_imageexport.h>

List of all members.

Public Member Functions

 JPEG2000ExportParam (u8 inNumOfZoomLevels=8, u16 inBlockSize=64, uint64_t inTargetFileSize=0)

Public Attributes

u8 numOfZoomLevels
 The number of zoom levels.
u16 blockSize
 The size of each tile (both of width and height).
uint64_t targetFileSize
 The final output file size.


Detailed Description

JPEG2000ExportParam structure is used with exportAsJPEG2000 function and it customizes the parameter for encoding JPEG2000 files. Before using this structure, you should zero-clear the whole instance to prevent some errors due to lack of the initialization.
See also:
Exporting Images, JPEG 2000 Image File Format

Definition at line 203 of file pxl_imageexport.h.


Constructor & Destructor Documentation

Celartem::ExportUtils::JPEG2000ExportParam::JPEG2000ExportParam ( u8  inNumOfZoomLevels = 8,
u16  inBlockSize = 64,
uint64_t  inTargetFileSize = 0 
) [inline]

This constructor initializes the structure.

Parameters:
inNumOfZoomLevels The number of zoom levels. Recommended default is 8.
inBlockSize The size of each tile (both of width and height). Recommended default is 64.
inTargetFileSize The final output file size. If 0 is specified, the encoder does not do any conditioning and the image is to be loss-less. If non-0 is specified, the encoder tries to adjust the file size to the specified size and then the image is lossy. Recommended default is 0.

Definition at line 238 of file pxl_imageexport.h.


Member Data Documentation

u8 Celartem::ExportUtils::JPEG2000ExportParam::numOfZoomLevels

The number of zoom levels.

The number of zoom levels. Recommended default is 8.

Definition at line 208 of file pxl_imageexport.h.

u16 Celartem::ExportUtils::JPEG2000ExportParam::blockSize

The size of each tile (both of width and height).

The size of each tile (both of width and height). Recommended default is 64.

Definition at line 214 of file pxl_imageexport.h.

uint64_t Celartem::ExportUtils::JPEG2000ExportParam::targetFileSize

The final output file size.

The final output file size. If 0 is specified, the encoder does not do any conditioning and the image is to be loss-less. If non-0 is specified, the encoder tries to adjust the file size to the specified size and then the image is lossy.

Definition at line 221 of file pxl_imageexport.h.


The documentation for this struct was generated from the following file:
This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:32 2008.