corona::Image Class Reference

#include <corona.h>

Inherits corona::DLLInterface.

Inheritance diagram for corona::Image:

Inheritance graph
[legend]
Collaboration diagram for corona::Image:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual int COR_CALL getWidth ()=0
virtual int COR_CALL getHeight ()=0
virtual PixelFormat COR_CALL getFormat ()=0
virtual void *COR_CALL getPixels ()=0
virtual void *COR_CALL getPalette ()=0
virtual int COR_CALL getPaletteSize ()=0
virtual PixelFormat COR_CALL getPaletteFormat ()=0

Detailed Description

An image object represents a rectangular collections of pixels. They have a width, a height, and a pixel format. Images cannot be resized.


Member Function Documentation

virtual int COR_CALL corona::Image::getWidth (  )  [pure virtual]

Get image width.

Returns:
image width

virtual int COR_CALL corona::Image::getHeight (  )  [pure virtual]

Get image height.

Returns:
image height

virtual PixelFormat COR_CALL corona::Image::getFormat (  )  [pure virtual]

Get pixel format.

Returns:
pixel format

virtual void* COR_CALL corona::Image::getPixels (  )  [pure virtual]

Get pixel buffer. The pixels are packed in the format defined by the image's pixel format.

Returns:
pointer to first element in pixel buffer

virtual void* COR_CALL corona::Image::getPalette (  )  [pure virtual]

Get the palette. Pixels are packed in the format defined by getPaletteFormat().

Returns:
pointer to first palette entry

virtual int COR_CALL corona::Image::getPaletteSize (  )  [pure virtual]

Get the number of entries in the palette.

Returns:
number of palette entries

virtual PixelFormat COR_CALL corona::Image::getPaletteFormat (  )  [pure virtual]

Get the format of the colors in the palette.

Returns:
pixel format of palette entries


The documentation for this class was generated from the following file:
Generated on Wed Jan 17 14:53:49 2007 for iTunesIslands by  doxygen 1.5.1-p1