---

corona::Image Class Reference

#include <corona.h>

Inheritance diagram for corona::Image:

[legend]Collaboration diagram for corona::Image:

[legend]List of all members.

Public Methods
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.

Definition at line 166 of file corona.h.

---

Member Function Documentation

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

Get image width. Returns: image width Implemented in corona::SimpleImage. Referenced by corona::DirectConversion(), corona::ExpandPalette(), corona::SavePNG(), and corona::SaveTGA().

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

Get image height. Returns: image height Implemented in corona::SimpleImage. Referenced by corona::DirectConversion(), corona::ExpandPalette(), corona::SavePNG(), and corona::SaveTGA().

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

Get pixel format. Returns: pixel format Implemented in corona::SimpleImage. Referenced by corona::DirectConversion(), and corona::SavePNG().

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 Implemented in corona::SimpleImage. Referenced by corona::DirectConversion(), corona::ExpandPalette(), corona::SavePNG(), and corona::SaveTGA().

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 Implemented in corona::SimpleImage. Referenced by corona::ExpandPalette(), and corona::SavePNG().

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

Get the number of entries in the palette. Returns: number of palette entries Implemented in corona::SimpleImage. Referenced by corona::SavePNG().

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

Get the format of the colors in the palette. Returns: pixel format of palette entries Implemented in corona::SimpleImage. Referenced by corona::ExpandPalette(), and corona::SavePNG().

---

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

• corona.h

---