ScummVM API documentation
Graphics::MacCursor Class Reference

#include <maccursor.h>

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

Public Member Functions

uint16 getWidth () const override
 
uint16 getHeight () const override
 
uint16 getHotspotX () const override
 
uint16 getHotspotY () const override
 
byte getKeyColor () const override
 
const byte * getSurface () const override
 
const byte * getPalette () const override
 
byte getPaletteStartIndex () const override
 
uint16 getPaletteCount () const override
 
bool readFromStream (Common::SeekableReadStream &stream, bool forceMonochrome=false, byte monochromeInvertedPixelColor=0xff, bool forceCURSFormat=false)
 
- Public Member Functions inherited from Graphics::Cursor
virtual const byte * getMask () const
 

Protected Member Functions

bool readFromCURS (Common::SeekableReadStream &stream, byte monochromeInvertedPixelColor)
 
bool readFromCRSR (Common::SeekableReadStream &stream, bool forceMonochrome, byte monochromeInvertedPixelColor)
 
void clear ()
 

Protected Attributes

byte * _surface
 
byte _palette [256 *3]
 
uint16 _hotspotX
 The cursor's hotspot's x coordinate.
 
uint16 _hotspotY
 The cursor's hotspot's y coordinate.
 

Detailed Description

A Mac crsr or CURS cursor

Member Function Documentation

◆ getWidth()

uint16 Graphics::MacCursor::getWidth ( void  ) const
inlineoverridevirtual

Return the cursor's width.

Implements Graphics::Cursor.

◆ getHeight()

uint16 Graphics::MacCursor::getHeight ( void  ) const
inlineoverridevirtual

Return the cursor's height.

Implements Graphics::Cursor.

◆ getHotspotX()

uint16 Graphics::MacCursor::getHotspotX ( ) const
inlineoverridevirtual

Return the cursor's hotspot's x coordinate.

Implements Graphics::Cursor.

◆ getHotspotY()

uint16 Graphics::MacCursor::getHotspotY ( ) const
inlineoverridevirtual

Return the cursor's hotspot's y coordinate.

Implements Graphics::Cursor.

◆ getKeyColor()

byte Graphics::MacCursor::getKeyColor ( ) const
inlineoverridevirtual

Return the cursor's transparent key.

Implements Graphics::Cursor.

◆ getSurface()

const byte* Graphics::MacCursor::getSurface ( ) const
inlineoverridevirtual

Return the cursor's surface.

Implements Graphics::Cursor.

◆ getPalette()

const byte* Graphics::MacCursor::getPalette ( ) const
inlineoverridevirtual

Return the cursor's palette in RGB format.

Implements Graphics::Cursor.

◆ getPaletteStartIndex()

byte Graphics::MacCursor::getPaletteStartIndex ( ) const
inlineoverridevirtual

Return the starting index of the palette.

Implements Graphics::Cursor.

◆ getPaletteCount()

uint16 Graphics::MacCursor::getPaletteCount ( ) const
inlineoverridevirtual

Return the number of colors in the palette.

Implements Graphics::Cursor.

◆ readFromStream()

bool Graphics::MacCursor::readFromStream ( Common::SeekableReadStream stream,
bool  forceMonochrome = false,
byte  monochromeInvertedPixelColor = 0xff,
bool  forceCURSFormat = false 
)

Read the cursor's data out of a stream.

◆ clear()

void Graphics::MacCursor::clear ( )
protected

Clear the cursor.


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