ScummVM API documentation
Graphics::Cursor Class Referenceabstract

#include <cursor.h>

Inheritance diagram for Graphics::Cursor:
Graphics::MacCursor Hadesch::PodImage Director::Cursor

Public Member Functions

virtual uint16 getWidth () const =0
 
virtual uint16 getHeight () const =0
 
virtual uint16 getHotspotX () const =0
 
virtual uint16 getHotspotY () const =0
 
virtual byte getKeyColor () const =0
 
virtual const byte * getSurface () const =0
 
virtual const byte * getMask () const
 
virtual const byte * getPalette () const =0
 
virtual byte getPaletteStartIndex () const =0
 
virtual uint16 getPaletteCount () const =0
 

Detailed Description

A simple cursor representation TODO: Switch to using Graphics::Surface instead of a byte*

Member Function Documentation

◆ getWidth()

virtual uint16 Graphics::Cursor::getWidth ( ) const
pure virtual

Return the cursor's width.

Implemented in Graphics::MacCursor, and Hadesch::PodImage.

◆ getHeight()

virtual uint16 Graphics::Cursor::getHeight ( ) const
pure virtual

Return the cursor's height.

Implemented in Graphics::MacCursor, and Hadesch::PodImage.

◆ getHotspotX()

virtual uint16 Graphics::Cursor::getHotspotX ( ) const
pure virtual

Return the cursor's hotspot's x coordinate.

Implemented in Graphics::MacCursor, and Hadesch::PodImage.

◆ getHotspotY()

virtual uint16 Graphics::Cursor::getHotspotY ( ) const
pure virtual

Return the cursor's hotspot's y coordinate.

Implemented in Graphics::MacCursor, and Hadesch::PodImage.

◆ getKeyColor()

virtual byte Graphics::Cursor::getKeyColor ( ) const
pure virtual

Return the cursor's transparent key.

Implemented in Graphics::MacCursor, Director::Cursor, and Hadesch::PodImage.

◆ getSurface()

virtual const byte* Graphics::Cursor::getSurface ( ) const
pure virtual

Return the cursor's surface.

Implemented in Graphics::MacCursor, and Hadesch::PodImage.

◆ getMask()

virtual const byte* Graphics::Cursor::getMask ( ) const
inlinevirtual

Return the cursor's mask, if it has one.

◆ getPalette()

virtual const byte* Graphics::Cursor::getPalette ( ) const
pure virtual

Return the cursor's palette in RGB format.

Implemented in Graphics::MacCursor, Director::Cursor, and Hadesch::PodImage.

◆ getPaletteStartIndex()

virtual byte Graphics::Cursor::getPaletteStartIndex ( ) const
pure virtual

Return the starting index of the palette.

Implemented in Graphics::MacCursor, and Hadesch::PodImage.

◆ getPaletteCount()

virtual uint16 Graphics::Cursor::getPaletteCount ( ) const
pure virtual

Return the number of colors in the palette.

Implemented in Graphics::MacCursor, and Hadesch::PodImage.


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