Method Groups for Class BitmapIO

The methods in this class are grouped below.

(Links go to the BitmapIO Class Reference page.)

Output Pixels

BitmapIO::GetOutputPixels(int x,int y,int pixels,BMM_Color_64 *ptr,BOOL preMultAlpha=TRUE)
BitmapIO::GetDitheredOutputPixels(int x,int y,int pixels,BMM_Color_32 *ptr,BOOL preMultAlpha=TRUE)

DIB Access

BitmapIO::GetOutputDib(int depth = 24)
BitmapIO::GetDitheredOutputDib(int depth = 24)

Output Gamma Setting

BitmapIO::OutputGamma()

Dithering

BitmapIO::DitherTrueColor()
BitmapIO::DitherPaletted()

Palette Computation

BitmapIO::CalcOutputPalette(int palsize, BMM_Color_48 *pal)

Open Mode Setting

BitmapIO::OpenMode()

Storage / Bitmap Access

BitmapIO::Storage()
BitmapIO::Map()

Filename Extensions

BitmapIO::ExtCount() = 0
BitmapIO::Ext( int n ) = 0

Author/Desc/Copyright/Version

BitmapIO::LongDesc( ) = 0
BitmapIO::ShortDesc() = 0
BitmapIO::AuthorName() = 0
BitmapIO::CopyrightMessage() = 0
BitmapIO::Version() = 0

Capabilities

BitmapIO::Capability() = 0

ShowAbout / ShowImage / ShowControl

BitmapIO::ShowAbout( HWND hWnd ) = 0
BitmapIO::ShowImage(HWND hWnd, BitmapInfo *bi)
BitmapIO::ShowControl( HWND hWnd, DWORD flag )

Parameter Block Methods

The following methods (EvaluateConfigure(), LoadConfigure(), SaveConfigure()) deal with parameter block loading and saving. See the sample code below to see how the EPS BitmapIO plug-in uses these methods.
 
typedef struct userSettable {
int units; // Inches or MM
int binary; // Whether want binary image data or not
int preview; // Whether want TIFF preview in file
int orientation; // Options are portrait or landscape
int colorType; // Whether image is output as rgb or gray
float paperHeight; // Height of output (for centering image)
float paperWidth; // Width of output (for centering image)
float xResolution; // In dots per inch
float yResolution; // In dots per inch
} UserSettable;
 
DWORD BitmapIO_EPS::EvaluateConfigure () {
return sizeof (UserSettable);
}
 
BOOL BitmapIO_EPS::LoadConfigure (void *ptr) {
UserSettable *buf = (UserSettable *) ptr;
memcpy (&userSettings, ptr, sizeof(UserSettable));
return TRUE;
}
 
BOOL BitmapIO_EPS::SaveConfigure (void *ptr) {
if (ptr) {
memcpy (ptr, &userSettings, sizeof(UserSettable));
return TRUE;
} else
return FALSE;
}
 
BitmapIO::EvaluateConfigure( ) = 0
BitmapIO::LoadConfigure( void *ptr ) = 0
BitmapIO::SaveConfigure( void *ptr ) = 0

Silent Mode Setting

BitmapIO::SilentMode()
BitmapIO::GetFrame(BitmapInfo *fbi, int *frame)

Critical Error Handling

BitmapIO::ProcessImageIOError(BitmapInfo *bi, TCHAR *string = NULL)
BitmapIO::ProcessImageIOError(BitmapInfo *bi, int errorcode)

G-Buffer Channels Required

BitmapIO::ChannelsRequired()

Image Information

BitmapIO::GetImageInfoDlg( HWND hWnd, BitmapInfo *bi, const TCHAR *filename = NULL )
BitmapIO::GetImageInfo( BitmapInfo *bi ) = 0
BitmapIO::GetImageName( BitmapInfo *bi, TCHAR *filename)
BitmapIO::EvalMatch(TCHAR *matchString)

Loading

BitmapIO::Load( BitmapInfo *bi, Bitmap *map, BMMRES *status ) = 0

Output / Write / Close

BitmapIO::OpenOutput(BitmapInfo *bi, Bitmap *map)
BitmapIO::Write(int frame)
BitmapIO::Close(int flag)

Internal use

BitmapIO::InitOutputGammaTable(BitmapInfo*bi)
BitmapIO::GetPaviFile()
BitmapIO::SetPrev(BitmapIO *prev)
BitmapIO::SetNext(BitmapIO *next)
BitmapIO::Prev()
BitmapIO::Next()

Default Options

These *Cfg* methods provide access to the default options of BitmapIO, as saved in its .cfg file. The options control how files are saved to disk (JPEG compression and smoothing, for example). Formerly, most BitmapIO types implemented these methods, yet they were not derived from any superclass. The method definitions are now moved to the BitmapIO superclass, so they can easily be called on any subclass.
Note: Introduced in 3ds Max 6 SDK.
BitmapIO::GetCfgFilename(TCHAR *filename)
BitmapIO::ReadCfg()
BitmapIO::WriteCfg()