User Tools

Site Tools


DzImageImporter

Base class for all image importers.

More...

Inherits :

Methods

Detailed Description

TODO: Add detailed description.

Methods


String : getDescription()

Return Value:

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

String : getExtension( Number i )

Return Value:

  • The file extension (excluding the preceding dot) supported by this importer.

Number : getNumExtensions()

Return Value:

  • The number of supported file extensions for this importer.

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

Reads the file.

Parameter(s):

  • filename - The name of the file to read.
  • image - Image to read data into.

DzError : loadImage( String filename, Image image )

Reads the file.

Parameter(s):

  • filename - The name of the file to read.
  • image - Image to read data into.

Boolean : recognize( String filename )

Test the given filename and file contents to see if this importer can read it.

Return Value:

  • true if the importer can import the file, otherwise false.