OpenArena::Image Class Reference

Write brief comment for Image here. More...

#include <image.h>

List of all members.

Public Types
	Type_RGB
enum	Type { Type_RGB }
Public Member Functions
virtual uint8 *	GetImageData () const =0
	Write brief comment for GetImageData here.
virtual uint32	GetBitsPerPixel () const =0
	Write brief comment for GetBitsPerPixel here.
virtual uint32	GetBytesPerPixel () const =0
	Write brief comment for GetBytesPerPixel here.
virtual uint32	GetWidth () const =0
	Write brief comment for GetWidth here.
virtual uint32	GetHeight () const =0
	Write brief comment for GetHeight here.
virtual Image::Type	GetType () const =0
	Write brief comment for GetType here.
virtual	~Image (void)
	Write brief comment for ~Image here.

---

Detailed Description

Write brief comment for Image here.

Write detailed description for Image here.

Remarks:

Write remarks for Image here.

See also:

Separate items with the '|' character.

---

Member Enumeration Documentation

enum OpenArena::Image::Type

Enumerator:

Type_RGB

---

Constructor & Destructor Documentation

virtual OpenArena::Image::~Image

(

void

)

[inline, virtual]

Write brief comment for ~Image here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for ~Image here.

Remarks:

Write remarks for ~Image here.

See also:

Separate items with the '|' character.

---

Member Function Documentation

virtual uint32 OpenArena::Image::GetBitsPerPixel

(

)

const [pure virtual]

Write brief comment for GetBitsPerPixel here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetBitsPerPixel here.

Remarks:

Write remarks for GetBitsPerPixel here.

See also:

Separate items with the '|' character.

virtual uint32 OpenArena::Image::GetBytesPerPixel

(

)

const [pure virtual]

Write brief comment for GetBytesPerPixel here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetBytesPerPixel here.

Remarks:

Write remarks for GetBytesPerPixel here.

See also:

Separate items with the '|' character.

virtual uint32 OpenArena::Image::GetHeight

(

)

const [pure virtual]

Write brief comment for GetHeight here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetHeight here.

Remarks:

Write remarks for GetHeight here.

See also:

Separate items with the '|' character.

virtual uint8* OpenArena::Image::GetImageData

(

)

const [pure virtual]

Write brief comment for GetImageData here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetImageData here.

Remarks:

Write remarks for GetImageData here.

See also:

Separate items with the '|' character.

virtual Image::Type OpenArena::Image::GetType

(

)

const [pure virtual]

Write brief comment for GetType here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetType here.

Remarks:

Write remarks for GetType here.

See also:

Separate items with the '|' character.

virtual uint32 OpenArena::Image::GetWidth

(

)

const [pure virtual]

Write brief comment for GetWidth here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetWidth here.

Remarks:

Write remarks for GetWidth here.

See also:

Separate items with the '|' character.

---

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

• src/image.h

---