Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSIBCPixMapDriver Class Reference

Base class for pixmap loader drivers. More...

#include <SIBCPixMap.h>

Inheritance diagram for CSIBCPixMapDriver::

CSIILBMPFileDriver CSIILGIFFileDriver CSIILJPGFileDriver CSIILPICFileDriver CSIILPPMFileDriver CSIILTGAFileDriver List of all members.

Public Methods


Detailed Description

Base class for pixmap loader drivers.


Constructor & Destructor Documentation

CSIBCPixMapDriver::CSIBCPixMapDriver  
 

Constructor

Returns:
an instance of CSIBCPixMapDriver

CSIBCPixMapDriver::~CSIBCPixMapDriver   [virtual]
 

Destructor


Member Function Documentation

virtual SI_Error CSIBCPixMapDriver::Load CSIBCString   i_Name,
CSIBCPixMap &    o_Map
[pure virtual]
 

Loads a bitmap file into a CSIBCPixMap object

Parameters:
in_filename  bitmap file name
in_PixMap  CSIBCPixMap object to load the file into
Returns:
SI_Error
Return values:
SI_SUCCESS  loading has been succesful
SI_ERR_ERROR_MSG  loading has failed
SI_FILE_NOT_FOUND  the file has not been found

Reimplemented in CSIILBMPFileDriver, CSIILGIFFileDriver, CSIILJPGFileDriver, CSIILPICFileDriver, CSIILPPMFileDriver, and CSIILTGAFileDriver.

virtual SI_Error CSIBCPixMapDriver::LoadFromMemory void *    pMemoryBlock,
SI_Int    nSize,
CSIBCPixMap &    o_Map
[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
Return values:
SI_SUCCESS  loading has been succesful
SI_ERR_ERROR_MSG  loading has failed
SI_FILE_NOT_FOUND  the file has not been found

Reimplemented in CSIILPICFileDriver.

virtual SI_Bool CSIBCPixMapDriver::Supported CSIBCString   i_Name [pure virtual]
 

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

Parameters:
in_Filename  file name to check
Returns:
SI_Bool
Return values:
TRUE  if this file is supported
FALSE  if this file is not supported

Reimplemented in CSIILBMPFileDriver, CSIILGIFFileDriver, CSIILJPGFileDriver, CSIILPICFileDriver, CSIILPPMFileDriver, and CSIILTGAFileDriver.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.