CSIBCPixMapDriver Class Reference

Base class for pixel map loader drivers. More...

#include <SIBCPixMap.h>

Inheritance diagram for CSIBCPixMapDriver:

CSIILBMPFileDriver CSIILDDSFileDriver CSIILGIFFileDriver CSIILJPGFileDriver CSIILPICFileDriver CSIILPNGFileDriver CSIILPPMFileDriver CSIILTGAFileDriver List of all members.

Public Member Functions
  CSIBCPixMapDriver ()
virtual  ~CSIBCPixMapDriver ()
virtual SI_Bool  Supported (CSIBCString &in_Filename)=0
virtual SI_Error  Load (CSIBCString &in_filename, CSIBCPixMap &in_PixMap)=0
virtual SI_Error  LoadFromMemory (void *in_pMemoryBlock, SI_Int in_lCount, CSIBCPixMap &in_PixMap)

Detailed Description

Base class for pixel map loader drivers.

Constructor & Destructor Documentation

CSIBCPixMapDriver (  ) 

Constructor

virtual ~CSIBCPixMapDriver (  )  [virtual]

Destructor

Member Function Documentation

virtual SI_Bool Supported ( CSIBCString &  in_Filename  )  [pure virtual]

Returns whether the extension passed in the string is supported by this driver

Parameters:
in_Filename  file name to check
Returns:
SI_Bool::TRUE if this file is supported

SI_Bool::FALSE if this file is not supported

Implemented in CSIILBMPFileDriver, CSIILDDSFileDriver, CSIILGIFFileDriver, CSIILJPGFileDriver, CSIILPICFileDriver, CSIILPNGFileDriver, CSIILPPMFileDriver, and CSIILTGAFileDriver.

virtual SI_Error Load ( CSIBCString &  in_filename,
CSIBCPixMap &  in_PixMap  
) [pure virtual]

Loads a bitmap file into a CSIBCPixMap object

Parameters:
in_filename  bitmap file name
in_PixMap  load file into this object
Returns:
SI_Error::SI_SUCCESS loading has been succesful

SI_Error::SI_ERR_ERROR_MSG loading has failed

SI_Error::SI_FILE_NOT_FOUND the file has not been found

Implemented in CSIILBMPFileDriver, CSIILDDSFileDriver, CSIILGIFFileDriver, CSIILJPGFileDriver, CSIILPICFileDriver, CSIILPNGFileDriver, CSIILPPMFileDriver, and CSIILTGAFileDriver.

virtual SI_Error LoadFromMemory ( void *  in_pMemoryBlock,
SI_Int  in_lCount,
CSIBCPixMap &  in_PixMap  
) [inline, virtual]

Loads a memory bitmap file into a CSIBCPixMap object

Parameters:
in_pMemoryBlock  memory block
in_lCount  memory block size
in_PixMap  CSIBCPixMap object to load the file into
Returns:
SI_Error::SI_SUCCESS loading has been succesful

SI_Error::SI_ERR_ERROR_MSG loading has failed

SI_Error::SI_FILE_NOT_FOUND the file has not been found

Reimplemented in CSIILPICFileDriver.

The documentation for this class was generated from the following file: