ImageIOInfo Class Reference

#include <ImageIO.h>

Collaboration diagram for ImageIOInfo:

Collaboration graph
[legend]
List of all members.

Public Attributes

String m_openfilter
String m_savefilter
String m_suffix
String m_localizedname
String m_matchname
String m_documentation
ULONG m_flags
BOOL m_candomultiframes: 1
BOOL m_canwrite: 1
BOOL m_haswriteoptions: 1
BOOL m_canstorealpha: 1
BOOL m_canstoresound: 1
BOOL m_canstoremultibuffers: 1
BOOL m_closewrite: 1

Detailed Description

ImageIOInfo is used to pass plugin functionalities and capabilities to Animation:Master.

Definition at line 35 of file ImageIO.h.


Member Data Documentation

BOOL ImageIOInfo::m_candomultiframes
 

Indicates if the plugin can process (read-write) multiple frames in one single file. QuickTime and AVI can obviously do that. Gif can too. But Targa can't.

Definition at line 40 of file ImageIO.h.

BOOL ImageIOInfo::m_canstorealpha
 

Indicates if the plugin can store alpha channels with the image data.

Definition at line 43 of file ImageIO.h.

BOOL ImageIOInfo::m_canstoremultibuffers
 

Indicates if the plugin can store multiple buffers.

OpenEXR and Jpeg2000 can do that.

Definition at line 45 of file ImageIO.h.

BOOL ImageIOInfo::m_canstoresound
 

Indicates if the plugin can store sound data. Either in the same file, with image data or on separate file.

Definition at line 44 of file ImageIO.h.

BOOL ImageIOInfo::m_canwrite
 

Indicates if the plugin can write to file.

All plugins must have read from file capability but may not write to file.

Definition at line 41 of file ImageIO.h.

BOOL ImageIOInfo::m_closewrite
 

Indicates if the plugin needs to close animation file after saving frames.

Definition at line 46 of file ImageIO.h.

String ImageIOInfo::m_documentation
 

Contains a HTML string describing the plugin and its usage.

Definition at line 54 of file ImageIO.h.

ULONG ImageIOInfo::m_flags
 

Definition at line 38 of file ImageIO.h.

BOOL ImageIOInfo::m_haswriteoptions
 

Indicates if the plugin provides a callable Save Options dialog box.

Most common Save Options dialogs are compression settings. Other common Save Option woud be bit depth.

Definition at line 42 of file ImageIO.h.

String ImageIOInfo::m_localizedname
 

Contains the name of the supported file type as displayed in the Render Option drop down list.

Definition at line 52 of file ImageIO.h.

String ImageIOInfo::m_matchname
 

Contains a unique name used to identify the plugin.

This name is stored in the project files and must be unique among plugins and may not contain spaces

Definition at line 53 of file ImageIO.h.

String ImageIOInfo::m_openfilter
 

Contains OpenFile dialog file filter.

The format is "|Display string|filter string|Macintosh filetype||"

Note:
since Mac OSX 10.4, the Macintosh filetype is no longer used and my be filled with any 4 characters if the plugin is to be used with A:M v13 and later.

Definition at line 49 of file ImageIO.h.

String ImageIOInfo::m_savefilter
 

Contains Save dialog file filter.

The format is "|Display string|filter string|Macintosh filetype||"

Note:
since Mac OSX 10.4, the Macintosh filetype is no longer used and my be filled with any 4 characters if the plugin is to be used with A:M v13 and later.

Definition at line 50 of file ImageIO.h.

String ImageIOInfo::m_suffix
 

Contains the prefered or most common file extension.

Only one extension. Do not include the dot.

Definition at line 51 of file ImageIO.h.


The documentation for this class was generated from the following files:
This A:M SDK v12.0 documentation is maintained by Hash Inc. Please address any comments concerning this documentation to AMReports. If you have any information, knowledge, or documentation to share with the A:M developer community, please post them on the Hash SDK forum.

Generated on Thu Oct 27 11:46:59 2005 with doxygen 1.4.5 written by Dimitri van Heesch, © 1997-2001