User Tools

Site Tools


DzImageExporter

Base class for all image exporters.

More...

Inherits :

Methods

Detailed Description

TODO: Add detailed description.

Methods


String : getDescription()

Return Value:

  • A description of the exporter that can be placed in a file type selection combo box (e.g. “JPEG Format”)

String : getExtension()

Return Value:

  • The extension that this exporter will force filenames to.

Boolean : isFileExporter()

Return Value:

  • 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 : saveImage( String filename, Image image )

Writes the file.

Parameter(s):

  • filename - The name of the file to save the image to.
  • image - Image to save to file.

Return Value:

  • DZ_NO_ERROR on success, otherwise an error code.

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

Writes the file.

Parameter(s):

  • filename - The name of the file to save the image to.
  • image - Image to save to file.
  • options - The options for the exporter.

Return Value:

  • DZ_NO_ERROR on success, otherwise an error code.