DzImageExporter Class Reference
[File Input and Output Objects]

Base class for all image exporters. More...

Inheritance diagram for DzImageExporter:

DzFileIO DzBase QObject Object DzLayeredImageExporter List of all members.

Methods

String getDescription ()
String getExtension ()
Boolean isFileExporter ()
DzError saveImage (String filename, Image image, DzFileIOSettings options)
DzError saveImage (String filename, Image image)

Detailed Description

Base class for all image exporters.


Member Function Documentation

String DzImageExporter::getDescription (  ) 

Returns:
A description of the exporter that can be placed in a file type selection combo box (e.g. "JPEG Format")

String DzImageExporter::getExtension (  ) 

Returns:
The extension that this exporter will force filenames to.

Boolean DzImageExporter::isFileExporter (  ) 

Returns:
true if this exporter writes to a 'real' file. Derived classes should override this to indicate whether or not they are writing out to a real file. Exporters can, if they want to, write to entities other than files (e.g. sockets, pipes, etc.)

DzError DzImageExporter::saveImage ( String  filename,
Image  image,
DzFileIOSettings  options 
)

Writes the file.

Parameters:
filename The name of the file to save the image to.
image Image to save to file.
options The options for the exporter.
Returns:
DZ_NO_ERROR on success, otherwise an error code.

DzError DzImageExporter::saveImage ( String  filename,
Image  image 
)

Writes the file.

Parameters:
filename The name of the file to save the image to.
image Image to save to file.
Returns:
DZ_NO_ERROR on success, otherwise an error code.


Generated on Thu Sep 24 12:21:12 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.