ICELib  1
Classes
iceBitmap
ICECore - IndieCity Extras integration interfaces

iceBitmap interface definition More...

Classes

class  iceBitmap
 iceBitmap interface Simple utility class for passing around bitmap data Opaque structure. More...

Reference Counting

void iceBitmap::iceBitmapAddReference (iceBitmap *pBitmap)
 Increase the refcount on the iceBitmap.
void iceBitmap::iceBitmapRelease (iceBitmap *pBitmap)
 Decrease the refcount on the iceBitmap Use this when you have finished using the iceBitmap interface You should set the pointer to NULL afterwards.

Construction

iceBitmapiceBitmap::iceBitmapCreate ()
 Create an empty bitmap object from file.
iceBitmapiceBitmap::iceBitmapCreateFromFile (const char *filename)
 Setup a bitmap object from file.
iceBitmapiceBitmap::iceBitmapCreateFromFileEx (const char *filename, PixelFormatType targetFormat)
 Setup a bitmap object from file.
iceBitmapiceBitmap::iceBitmapCreateFromMemory (const unsigned char *bitmapData, unsigned long dataLength)
 Setup a bitmap object from file.
iceBitmapiceBitmap::iceBitmapCreateFromMemoryEx (const unsigned char *bitmapData, unsigned long dataLength, PixelFormatType targetFormat)
 Setup a bitmap object from file.
iceBitmapiceBitmap::iceBitmapCreateFromMemoryDirect (unsigned long width, unsigned long height, unsigned long stride, PixelFormatType pft, const unsigned char *data)
 Setup a bitmap object from file.

Copying

iceBitmapiceBitmap::iceBitmapClone (const iceBitmap *pBitmap)
 Create a new bitmap object from an existing one.
IceCoreResult iceBitmap::iceBitmapCopy (iceBitmap *dst, const iceBitmap *src)
 Copy bitmap data from one bitmap to another.

Saving

IceCoreResult iceBitmap::iceBitmapSave (const iceBitmap *pBitmap, const char *filename, ImageFileType fileType)
 Setup a bitmap object from file.
IceCoreResult iceBitmap::iceBitmapSaveToMemory (const iceBitmap *pBitmap, unsigned char *buffer, unsigned long *bufferSize, ImageFileType fileType)
 Setup a bitmap object from file.

Properties

void iceBitmap::iceBitmapGetDimensions (const iceBitmap *pBitmap, unsigned long *widthPixels, unsigned long *heightPixels)
 Setup a bitmap object from file.
unsigned long iceBitmap::iceBitmapGetHeight (const iceBitmap *pBitmap)
 Setup a bitmap object from file.
unsigned long iceBitmap::iceBitmapGetWidth (const iceBitmap *pBitmap)
 Setup a bitmap object from file.
unsigned long iceBitmap::iceBitmapGetStride (const iceBitmap *pBitmap)
 Setup a bitmap object from file.
unsigned long iceBitmap::iceBitmapGetBitmapFlags (const iceBitmap *pBitmap)
 Setup a bitmap object from file.
PixelFormatType iceBitmap::iceBitmapGetPixelFormat (const iceBitmap *pBitmap)
 Setup a bitmap object from file.
IceCoreResult iceBitmap::iceBitmapChangePixelFormat (iceBitmap *pBitmap, PixelFormatType pixelType)
 Setup a bitmap object from file.

Detailed Description

iceBitmap interface definition

Functions for loading a bmp,jpg,png image


Function Documentation

void iceBitmapAddReference ( iceBitmap pBitmap)

Increase the refcount on the iceBitmap.

Parameters:
[in]pBitmappointer to iceBitmap interface This should be used if the iceBitmap* is to be stored
IceCoreResult iceBitmapChangePixelFormat ( iceBitmap pBitmap,
PixelFormatType  pixelType 
)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
iceBitmap * iceBitmapClone ( const iceBitmap pBitmap)

Create a new bitmap object from an existing one.

Parameters:
[in]pBitmappointer to bitmap to clone
Returns:
iceBitmap*
IceCoreResult iceBitmapCopy ( iceBitmap dst,
const iceBitmap src 
)

Copy bitmap data from one bitmap to another.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*

Create an empty bitmap object from file.

Returns:
iceBitmap*
iceBitmap * iceBitmapCreateFromFile ( const char *  filename)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
iceBitmap * iceBitmapCreateFromFileEx ( const char *  filename,
PixelFormatType  targetFormat 
)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
iceBitmap * iceBitmapCreateFromMemory ( const unsigned char *  bitmapData,
unsigned long  dataLength 
)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
iceBitmap * iceBitmapCreateFromMemoryDirect ( unsigned long  width,
unsigned long  height,
unsigned long  stride,
PixelFormatType  pft,
const unsigned char *  data 
)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
iceBitmap * iceBitmapCreateFromMemoryEx ( const unsigned char *  bitmapData,
unsigned long  dataLength,
PixelFormatType  targetFormat 
)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
unsigned long iceBitmapGetBitmapFlags ( const iceBitmap pBitmap)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
void iceBitmapGetDimensions ( const iceBitmap pBitmap,
unsigned long *  widthPixels,
unsigned long *  heightPixels 
)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
unsigned long iceBitmapGetHeight ( const iceBitmap pBitmap)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
PixelFormatType iceBitmapGetPixelFormat ( const iceBitmap pBitmap)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
unsigned long iceBitmapGetStride ( const iceBitmap pBitmap)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
unsigned long iceBitmapGetWidth ( const iceBitmap pBitmap)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
IceCoreResult iceBitmapSave ( const iceBitmap pBitmap,
const char *  filename,
ImageFileType  fileType 
)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
IceCoreResult iceBitmapSaveToMemory ( const iceBitmap pBitmap,
unsigned char *  buffer,
unsigned long *  bufferSize,
ImageFileType  fileType 
)

Setup a bitmap object from file.

Parameters:
filenamethe name of the bitmap file to read in.
Returns:
iceBitmap*
 All Classes Functions