ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Graphics::WinCursor Class Reference

A Windows cursor. More...

Inheritance diagram for Graphics::WinCursor:
Collaboration diagram for Graphics::WinCursor:

List of all members.

Public Member Functions

 WinCursor ()
 ~WinCursor ()
uint16 getWidth () const
 Return the cursor's width.
uint16 getHeight () const
 Return the cursor's height.
uint16 getHotspotX () const
 Return the cursor's hotspot's x coordinate.
uint16 getHotspotY () const
 Return the cursor's hotspot's y coordinate.
byte getKeyColor () const
 Return the cursor's transparent key.
const bytegetSurface () const
 Return the cursor's surface.
const bytegetPalette () const
 Return the cursor's palette in RGB format.
byte getPaletteStartIndex () const
 Return the starting index of the palette.
uint16 getPaletteCount () const
 Return the number of colors in the palette.
bool readFromStream (Common::SeekableReadStream &stream)
 Read the cursor's data out of a stream.

Private Member Functions

void clear ()
 Clear the cursor.

Private Attributes

byte_surface
byte _palette [256 *3]
uint16 _width
 The cursor's width.
uint16 _height
 The cursor's height.
uint16 _hotspotX
 The cursor's hotspot's x coordinate.
uint16 _hotspotY
 The cursor's hotspot's y coordinate.
byte _keyColor
 The cursor's transparent key.

Detailed Description

A Windows cursor.

Definition at line 34 of file wincursor.cpp.


Constructor & Destructor Documentation

Graphics::WinCursor::WinCursor (  ) 

Definition at line 73 of file wincursor.cpp.

Graphics::WinCursor::~WinCursor (  ) 

Definition at line 83 of file wincursor.cpp.


Member Function Documentation

void Graphics::WinCursor::clear (  )  [private]

Clear the cursor.

Definition at line 233 of file wincursor.cpp.

uint16 Graphics::WinCursor::getHeight (  )  const [virtual]

Return the cursor's height.

Implements Graphics::Cursor.

Definition at line 91 of file wincursor.cpp.

uint16 Graphics::WinCursor::getHotspotX (  )  const [virtual]

Return the cursor's hotspot's x coordinate.

Implements Graphics::Cursor.

Definition at line 95 of file wincursor.cpp.

uint16 Graphics::WinCursor::getHotspotY (  )  const [virtual]

Return the cursor's hotspot's y coordinate.

Implements Graphics::Cursor.

Definition at line 99 of file wincursor.cpp.

byte Graphics::WinCursor::getKeyColor (  )  const [virtual]

Return the cursor's transparent key.

Implements Graphics::Cursor.

Definition at line 103 of file wincursor.cpp.

const byte* Graphics::WinCursor::getPalette (  )  const [inline, virtual]

Return the cursor's palette in RGB format.

Implements Graphics::Cursor.

Definition at line 52 of file wincursor.cpp.

uint16 Graphics::WinCursor::getPaletteCount (  )  const [inline, virtual]

Return the number of colors in the palette.

Implements Graphics::Cursor.

Definition at line 54 of file wincursor.cpp.

byte Graphics::WinCursor::getPaletteStartIndex (  )  const [inline, virtual]

Return the starting index of the palette.

Implements Graphics::Cursor.

Definition at line 53 of file wincursor.cpp.

const byte* Graphics::WinCursor::getSurface (  )  const [inline, virtual]

Return the cursor's surface.

Implements Graphics::Cursor.

Definition at line 50 of file wincursor.cpp.

uint16 Graphics::WinCursor::getWidth (  )  const [virtual]

Return the cursor's width.

Implements Graphics::Cursor.

Definition at line 87 of file wincursor.cpp.

bool Graphics::WinCursor::readFromStream ( Common::SeekableReadStream stream  ) 

Read the cursor's data out of a stream.

Definition at line 107 of file wincursor.cpp.


Member Data Documentation

The cursor's height.

Definition at line 64 of file wincursor.cpp.

The cursor's hotspot's x coordinate.

Definition at line 65 of file wincursor.cpp.

The cursor's hotspot's y coordinate.

Definition at line 66 of file wincursor.cpp.

The cursor's transparent key.

Definition at line 67 of file wincursor.cpp.

Definition at line 61 of file wincursor.cpp.

Definition at line 60 of file wincursor.cpp.

The cursor's width.

Definition at line 63 of file wincursor.cpp.


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


Generated on Sat Mar 16 2019 05:05:51 for ResidualVM by doxygen 1.7.1
curved edge   curved edge