CrystalSpace

Public API Reference

csGLScreenShot Class Reference
[Common Plugin Classes]

OpenGL screen shot. More...

#include <csplugincommon/opengl/glss.h>

Inheritance diagram for csGLScreenShot:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void DecRef ()
 Decrement the reference count.
virtual int GetFormat () const
 Qyery image format (see CS_IMGFMT_XXX above).
virtual int GetHeight () const
 Query image height.
virtual const void * GetImageData ()
 Get image data: returns either (csRGBpixel *) or (unsigned char *) depending on format.
virtual int GetWidth () const
 Query image width.
void IncRef ()
 Increment the number of references to this object.

Public Attributes

csGLScreenShotpoolNext

Detailed Description

OpenGL screen shot.

Definition at line 39 of file glss.h.


Member Function Documentation

void csGLScreenShot::DecRef (  )  [virtual]

Decrement the reference count.

Reimplemented from scfImplementation< csImageBase >.

virtual int csGLScreenShot::GetFormat (  )  const [inline, virtual]

Qyery image format (see CS_IMGFMT_XXX above).

Implements iImage.

Definition at line 60 of file glss.h.

virtual int csGLScreenShot::GetHeight (  )  const [inline, virtual]

Query image height.

Implements iImage.

Definition at line 58 of file glss.h.

virtual const void* csGLScreenShot::GetImageData (  )  [inline, virtual]

Get image data: returns either (csRGBpixel *) or (unsigned char *) depending on format.

Note that for RGBA images the csRGBpixel structure contains the alpha channel as well, so GetAlpha (see below) method will return 0 (because alpha is not stored separately, as for paletted images).

Implements iImage.

Definition at line 54 of file glss.h.

virtual int csGLScreenShot::GetWidth (  )  const [inline, virtual]

Query image width.

Implements iImage.

Definition at line 56 of file glss.h.

void csGLScreenShot::IncRef (  )  [virtual]

Increment the number of references to this object.

Reimplemented from scfImplementation< csImageBase >.


The documentation for this class was generated from the following file:
Generated for Crystal Space 1.0.2 by doxygen 1.4.7