aboutsummaryrefslogtreecommitdiff
path: root/engines
diff options
context:
space:
mode:
authorMax Horn2009-10-08 21:28:57 +0000
committerMax Horn2009-10-08 21:28:57 +0000
commit3399c3aeb638ae874557c72b4ab4db016ff152c8 (patch)
treef476b2a87837568da3bcdaf031f4eb61293f5086 /engines
parent2ab906bafd7e154bb9e333d7e76fe2a714478efd (diff)
downloadscummvm-rg350-3399c3aeb638ae874557c72b4ab4db016ff152c8.tar.gz
scummvm-rg350-3399c3aeb638ae874557c72b4ab4db016ff152c8.tar.bz2
scummvm-rg350-3399c3aeb638ae874557c72b4ab4db016ff152c8.zip
Change doxygen inline comments from "//!" to "///" as proposed on -devel
svn-id: r44802
Diffstat (limited to 'engines')
-rw-r--r--engines/cine/pal.h4
-rw-r--r--engines/cine/unpack.h18
-rw-r--r--engines/cine/various.cpp2
-rw-r--r--engines/draci/barchive.h18
-rw-r--r--engines/draci/game.h6
-rw-r--r--engines/draci/sprite.h12
-rw-r--r--engines/draci/surface.h2
-rw-r--r--engines/gob/save/saveload.h12
-rw-r--r--engines/queen/walk.h30
-rw-r--r--engines/sci/decompressor.h12
-rw-r--r--engines/sci/engine/segment.h6
-rw-r--r--engines/sci/gfx/font.h6
-rw-r--r--engines/sci/gfx/gfx_gui.h16
-rw-r--r--engines/sci/resource.h14
-rw-r--r--engines/sci/sfx/iterator_internal.h50
-rw-r--r--engines/scumm/smush/channel.h18
-rw-r--r--engines/tinsel/actors.cpp6
-rw-r--r--engines/tinsel/actors.h4
-rw-r--r--engines/tinsel/anim.h40
-rw-r--r--engines/tinsel/background.h32
-rw-r--r--engines/tinsel/dialogs.cpp18
-rw-r--r--engines/tinsel/handle.cpp24
-rw-r--r--engines/tinsel/multiobj.h14
-rw-r--r--engines/tinsel/object.h72
-rw-r--r--engines/tinsel/palette.cpp10
-rw-r--r--engines/tinsel/palette.h32
-rw-r--r--engines/tinsel/pcode.cpp94
-rw-r--r--engines/tinsel/pcode.h30
-rw-r--r--engines/tinsel/polygons.cpp28
-rw-r--r--engines/tinsel/scene.cpp4
-rw-r--r--engines/tinsel/scene.h10
-rw-r--r--engines/tinsel/sched.h14
-rw-r--r--engines/tinsel/text.h38
33 files changed, 347 insertions, 349 deletions
diff --git a/engines/cine/pal.h b/engines/cine/pal.h
index d0621b4d9f..4d32aca408 100644
--- a/engines/cine/pal.h
+++ b/engines/cine/pal.h
@@ -189,8 +189,8 @@ private:
Cine::Palette::Color saturatedAddColor(Cine::Palette::Color baseColor, signed r, signed g, signed b) const;
private:
- Graphics::PixelFormat _format; //!< The used source color format
- Common::Array<Color> _colors; //!< The actual palette data
+ Graphics::PixelFormat _format; ///< The used source color format
+ Common::Array<Color> _colors; ///< The actual palette data
};
} // End of namespace Cine
diff --git a/engines/cine/unpack.h b/engines/cine/unpack.h
index 96d6d20158..3215689867 100644
--- a/engines/cine/unpack.h
+++ b/engines/cine/unpack.h
@@ -99,17 +99,17 @@ private:
*/
void copyRelocatedBytes(uint offset, uint numBytes);
private:
- uint32 _crc; //!< Error-detecting code (This should be zero after successful unpacking)
- uint32 _chunk32b; //!< The current internal 32-bit chunk of source data
- byte *_dst; //!< Pointer to the current position in the destination buffer
- const byte *_src; //!< Pointer to the current position in the source buffer
+ uint32 _crc; ///< Error-detecting code (This should be zero after successful unpacking)
+ uint32 _chunk32b; ///< The current internal 32-bit chunk of source data
+ byte *_dst; ///< Pointer to the current position in the destination buffer
+ const byte *_src; ///< Pointer to the current position in the source buffer
// These are used for detecting errors (e.g. out of bounds issues) during unpacking
- bool _error; //!< Did an error occur during unpacking?
- const byte *_srcBegin; //!< Source buffer's beginning
- const byte *_srcEnd; //!< Source buffer's end
- byte *_dstBegin; //!< Destination buffer's beginning
- byte *_dstEnd; //!< Destination buffer's end
+ bool _error; ///< Did an error occur during unpacking?
+ const byte *_srcBegin; ///< Source buffer's beginning
+ const byte *_srcEnd; ///< Source buffer's end
+ byte *_dstBegin; ///< Destination buffer's beginning
+ byte *_dstEnd; ///< Destination buffer's end
};
} // End of namespace Cine
diff --git a/engines/cine/various.cpp b/engines/cine/various.cpp
index 78a347b321..019f57d775 100644
--- a/engines/cine/various.cpp
+++ b/engines/cine/various.cpp
@@ -123,7 +123,7 @@ CommandeType objectListCommand[20];
int16 objListTab[20];
Common::Array<uint16> zoneData;
-Common::Array<uint16> zoneQuery; //!< Only exists in Operation Stealth
+Common::Array<uint16> zoneQuery; ///< Only exists in Operation Stealth
/*! \brief Move the player character using the keyboard
* \param x Negative values move left, positive right, zero not at all
diff --git a/engines/draci/barchive.h b/engines/draci/barchive.h
index cb3c068289..0d77742de2 100644
--- a/engines/draci/barchive.h
+++ b/engines/draci/barchive.h
@@ -34,12 +34,12 @@ namespace Draci {
* Represents individual files inside the archive.
*/
struct BAFile {
- uint _compLength; //!< Compressed length (the same as _length if the file is uncompressed)
- uint _length; //!< Uncompressed length
- uint32 _offset; //!< Offset of file inside archive
+ uint _compLength; ///< Compressed length (the same as _length if the file is uncompressed)
+ uint _length; ///< Uncompressed length
+ uint32 _offset; ///< Offset of file inside archive
byte *_data;
byte _crc;
- byte _stopper; //!< Not used in BAR files, needed for DFW
+ byte _stopper; ///< Not used in BAR files, needed for DFW
/** Releases the file data (for memory considerations) */
void close(void) {
@@ -82,11 +82,11 @@ private:
// File stream header data
static const uint _fileHeaderSize = 6;
- Common::String _path; //!< Path to file
- BAFile *_files; //!< Internal array of files
- uint _fileCount; //!< Number of files in archive
- bool _isDFW; //!< True if the archive is in DFW format, false otherwise
- bool _opened; //!< True if the archive is opened, false otherwise
+ Common::String _path; ///< Path to file
+ BAFile *_files; ///< Internal array of files
+ uint _fileCount; ///< Number of files in archive
+ bool _isDFW; ///< True if the archive is in DFW format, false otherwise
+ bool _opened; ///< True if the archive is opened, false otherwise
void openDFW(const Common::String &path);
BAFile *loadFileDFW(uint i) const;
diff --git a/engines/draci/game.h b/engines/draci/game.h
index 6e2f6f9f61..57f0c799ae 100644
--- a/engines/draci/game.h
+++ b/engines/draci/game.h
@@ -90,8 +90,8 @@ enum InventoryConstants {
kInventoryItemHeight = 25,
kInventoryColumns = 7,
kInventoryLines = 5,
- kInventoryX = 70, //!< Used for positioning of the inventory sprite on the X axis
- kInventoryY = 30, //!< Used for positioning of the inventory sprite on the Y axis
+ kInventoryX = 70, ///< Used for positioning of the inventory sprite on the X axis
+ kInventoryY = 30, ///< Used for positioning of the inventory sprite on the Y axis
kInventorySlots = kInventoryLines * kInventoryColumns
};
@@ -398,7 +398,7 @@ private:
int _oldObjUnderCursor;
int _animUnderCursor;
- int _markedAnimationIndex; //!< Used by the Mark GPL command
+ int _markedAnimationIndex; ///< Used by the Mark GPL command
int _scheduledPalette;
};
diff --git a/engines/draci/sprite.h b/engines/draci/sprite.h
index a5859f989c..5f0a425183 100644
--- a/engines/draci/sprite.h
+++ b/engines/draci/sprite.h
@@ -74,11 +74,11 @@ public:
virtual DrawableType getType() const = 0;
protected:
- uint _width; //!< Width of the sprite
- uint _height; //!< Height of the sprite
- uint _scaledWidth; //!< Scaled width of the sprite
- uint _scaledHeight; //!< Scaled height of the sprite
- int _x, _y; //!< Sprite coordinates
+ uint _width; ///< Width of the sprite
+ uint _height; ///< Height of the sprite
+ uint _scaledWidth; ///< Scaled width of the sprite
+ uint _scaledHeight; ///< Scaled height of the sprite
+ int _x, _y; ///< Sprite coordinates
/** The time a drawable should stay on the screen
* before being replaced by another or deleted
@@ -120,7 +120,7 @@ public:
DrawableType getType() const { return kDrawableSprite; }
private:
- const byte *_data; //!< Pointer to a buffer containing raw sprite data (row-wise)
+ const byte *_data; ///< Pointer to a buffer containing raw sprite data (row-wise)
bool _mirror;
};
diff --git a/engines/draci/surface.h b/engines/draci/surface.h
index 90ed9a110b..be2e6626c5 100644
--- a/engines/draci/surface.h
+++ b/engines/draci/surface.h
@@ -60,7 +60,7 @@ private:
*/
bool _fullUpdate;
- Common::List<Common::Rect> _dirtyRects; //!< List of currently dirty rectangles
+ Common::List<Common::Rect> _dirtyRects; ///< List of currently dirty rectangles
};
diff --git a/engines/gob/save/saveload.h b/engines/gob/save/saveload.h
index eb580b69de..d2206b1cef 100644
--- a/engines/gob/save/saveload.h
+++ b/engines/gob/save/saveload.h
@@ -38,10 +38,10 @@ class SaveLoad {
public:
/** How to handle the specific save. */
enum SaveMode {
- kSaveModeNone, //!< Don't handle it
- kSaveModeIgnore, //!< Ignore it
- kSaveModeExists, //!< Just claim it exists
- kSaveModeSave //!< A normal save
+ kSaveModeNone, ///< Don't handle it
+ kSaveModeIgnore, ///< Ignore it
+ kSaveModeExists, ///< Just claim it exists
+ kSaveModeSave ///< A normal save
};
/** The constructor.
@@ -146,8 +146,8 @@ public:
static const uint32 kIndexSize = kSlotCount * kSlotNameLength;
enum ScreenshotType {
- kScreenshotTypeGob3, //!< Goblins 3 type screenshot
- kScreenshotTypeLost //!< Lost in Time type screenshot
+ kScreenshotTypeGob3, ///< Goblins 3 type screenshot
+ kScreenshotTypeLost ///< Lost in Time type screenshot
};
SaveLoad_v3(GobEngine *vm, const char *targetName, ScreenshotType sShotType);
diff --git a/engines/queen/walk.h b/engines/queen/walk.h
index c64397e9c4..0f746213ab 100644
--- a/engines/queen/walk.h
+++ b/engines/queen/walk.h
@@ -87,41 +87,41 @@ private:
void animatePersonPrepare(const MovePersonData *mpd, int direction);
void animatePerson(const MovePersonData *mpd, uint16 image, uint16 bobNum, uint16 bankNum, int direction);
- //! compute transition coordinate
+ /// compute transition coordinate
static int16 calcC(int16 c1, int16 c2, int16 c3, int16 c4, int16 lastc);
- //! find area for position
+ /// find area for position
int16 findAreaPosition(int16 *x, int16 *y, bool recalibrate);
- //! find an area not already struck
+ /// find an area not already struck
uint16 findFreeArea(uint16 area) const;
- //! return true if the area is already on the walking path
+ /// return true if the area is already on the walking path
bool isAreaStruck(uint16 area) const;
- //! calculates the path list from oldArea to newArea
+ /// calculates the path list from oldArea to newArea
bool calcPath(uint16 oldArea, uint16 newArea);
- //! resets path computed in calcPath()
+ /// resets path computed in calcPath()
void initWalkData();
- //! add an area to the path
+ /// add an area to the path
void incWalkData(int16 px, int16 py, int16 x, int16 y, uint16 area);
- //! compute path (and populates _walkData) from current position to the new one
+ /// compute path (and populates _walkData) from current position to the new one
bool calc(uint16 oldPos, uint16 newPos, int16 oldx, int16 oldy, int16 x, int16 y);
- //! areas for current room
+ /// areas for current room
const Area *_roomArea;
- //! number of areas for current room
+ /// number of areas for current room
uint16 _roomAreaCount;
- //! walking steps
+ /// walking steps
WalkData _walkData[MAX_WALK_DATA];
- //! number of walking steps
+ /// number of walking steps
uint16 _walkDataCount;
uint16 _areaStrike[MAX_WALK_DATA];
@@ -130,15 +130,15 @@ private:
uint16 _areaList[MAX_WALK_DATA];
uint16 _areaListCount;
- //! set if stopJoe() is called
+ /// set if stopJoe() is called
bool _joeInterrupted;
- //! set if handleSpecialArea() is called
+ /// set if handleSpecialArea() is called
bool _joeMoveBlock;
QueenEngine *_vm;
- //! persons walking animation data
+ /// persons walking animation data
static const MovePersonData _moveData[];
};
diff --git a/engines/sci/decompressor.h b/engines/sci/decompressor.h
index 9fd7510e3b..b49452ebc3 100644
--- a/engines/sci/decompressor.h
+++ b/engines/sci/decompressor.h
@@ -108,12 +108,12 @@ protected:
return (_dwWrote == _szUnpacked) && (_dwRead >= _szPacked);
}
- uint32 _dwBits; //!< bits buffer
- byte _nBits; //!< number of unread bits in _dwBits
- uint32 _szPacked; //!< size of the compressed data
- uint32 _szUnpacked; //!< size of the decompressed data
- uint32 _dwRead; //!< number of bytes read from _src
- uint32 _dwWrote; //!< number of bytes written to _dest
+ uint32 _dwBits; ///< bits buffer
+ byte _nBits; ///< number of unread bits in _dwBits
+ uint32 _szPacked; ///< size of the compressed data
+ uint32 _szUnpacked; ///< size of the decompressed data
+ uint32 _dwRead; ///< number of bytes read from _src
+ uint32 _dwWrote; ///< number of bytes written to _dest
Common::ReadStream *_src;
byte *_dest;
};
diff --git a/engines/sci/engine/segment.h b/engines/sci/engine/segment.h
index d88c0dac17..d9c58e9b85 100644
--- a/engines/sci/engine/segment.h
+++ b/engines/sci/engine/segment.h
@@ -30,17 +30,15 @@
#include "sci/engine/vm.h"
#include "sci/engine/vm_types.h" // for reg_t
-//#include "common/util.h"
-
namespace Sci {
struct SegmentRef {
- bool isRaw; ///! true if data is raw, false if it is a reg_t sequence
+ bool isRaw; ///< true if data is raw, false if it is a reg_t sequence
union {
byte *raw;
reg_t *reg;
};
- int maxSize; ///! number of available bytes
+ int maxSize; ///< number of available bytes
// TODO: Add this?
//reg_t pointer; // Original pointer
diff --git a/engines/sci/gfx/font.h b/engines/sci/gfx/font.h
index fe0d81d135..af7a5f19e7 100644
--- a/engines/sci/gfx/font.h
+++ b/engines/sci/gfx/font.h
@@ -78,9 +78,9 @@ struct gfx_bitmap_font_t {
* SCI0, SCI01 and SCI1 all use the same font format.
*/
enum fontFlags {
- kFontCountWhitespace = 1 << 0, //!< In SQ3, whitespace is included in text size
- kFontNoNewlines = 1 << 1, //!< Don't treat newline characters
- kFontIgnoreLF = 1 << 2 //!< Interpret CR LF sequences as a single newline, rather than two
+ kFontCountWhitespace = 1 << 0, ///< In SQ3, whitespace is included in text size
+ kFontNoNewlines = 1 << 1, ///< Don't treat newline characters
+ kFontIgnoreLF = 1 << 2 ///< Interpret CR LF sequences as a single newline, rather than two
};
/**
diff --git a/engines/sci/gfx/gfx_gui.h b/engines/sci/gfx/gfx_gui.h
index 68342aa0c0..fe7eb1bb50 100644
--- a/engines/sci/gfx/gfx_gui.h
+++ b/engines/sci/gfx/gfx_gui.h
@@ -38,8 +38,8 @@ class Menu;
* Flags for windows in SCI0.
*/
enum windowFlags {
- kWindowTransparent = 0x01, //!< 0000 0001
- kWindowNoFrame = 0x02, //!< 0000 0010 - a window without a frame
+ kWindowTransparent = 0x01, ///< 0000 0001
+ kWindowNoFrame = 0x02, ///< 0000 0010 - a window without a frame
kWindowTitle = 0x04, /**
* 0000 0100 - Add title bar to
* window (10 pixels high, framed,
@@ -47,17 +47,17 @@ enum windowFlags {
* white on dark gray), bits 3-6
* are unused
*/
- kWindowDontDraw = 0x80, //!< 1000 0000 - don't draw anything
- kWindowNoDropShadow = 0x1000000, //!< 0001 0000 0000 0000 0000 0000 0000 (not in SCI)
+ kWindowDontDraw = 0x80, ///< 1000 0000 - don't draw anything
+ kWindowNoDropShadow = 0x1000000, ///< 0001 0000 0000 0000 0000 0000 0000 (not in SCI)
kWindowAutoRestore = 0x2000000
};
/** Button and frame control flags. */
enum controlStateFlags {
- kControlStateEnabled = 0x0001, //!< 0001 - enabled buttons (used by the interpreter)
- kControlStateDisabled = 0x0004, //!< 0010 - grayed out buttons (used by the interpreter)
- kControlStateFramed = 0x0008, //!< 1000 - widgets surrounded by a frame (used by the interpreter)
- kControlStateDitherFramed = 0x1000 //!< 0001 0000 0000 0000 - widgets surrounded by a dithered frame (used in kgraphics)
+ kControlStateEnabled = 0x0001, ///< 0001 - enabled buttons (used by the interpreter)
+ kControlStateDisabled = 0x0004, ///< 0010 - grayed out buttons (used by the interpreter)
+ kControlStateFramed = 0x0008, ///< 1000 - widgets surrounded by a frame (used by the interpreter)
+ kControlStateDitherFramed = 0x1000 ///< 0001 0000 0000 0000 - widgets surrounded by a dithered frame (used in kgraphics)
};
/**
diff --git a/engines/sci/resource.h b/engines/sci/resource.h
index 2400f2c8dd..2aaaa7d37f 100644
--- a/engines/sci/resource.h
+++ b/engines/sci/resource.h
@@ -282,14 +282,14 @@ protected:
ViewType _viewType; // Used to determine if the game has EGA or VGA graphics
Common::List<ResourceSource *> _sources;
- int _memoryLocked; //!< Amount of resource bytes in locked memory
- int _memoryLRU; //!< Amount of resource bytes under LRU control
- Common::List<Resource *> _LRU; //!< Last Resource Used list
+ int _memoryLocked; ///< Amount of resource bytes in locked memory
+ int _memoryLRU; ///< Amount of resource bytes under LRU control
+ Common::List<Resource *> _LRU; ///< Last Resource Used list
ResourceMap _resMap;
- Common::List<Common::File *> _volumeFiles; //!< list of opened volume files
- ResourceSource *_audioMapSCI1; //!< Currently loaded audio map for SCI1
- ResVersion _volVersion; //!< RESOURCE.0xx version
- ResVersion _mapVersion; //!< RESOURCE.MAP version
+ Common::List<Common::File *> _volumeFiles; ///< list of opened volume files
+ ResourceSource *_audioMapSCI1; ///< Currently loaded audio map for SCI1
+ ResVersion _volVersion; ///< RESOURCE.0xx version
+ ResVersion _mapVersion; ///< RESOURCE.MAP version
/**
* Initializes the resource manager
diff --git a/engines/sci/sfx/iterator_internal.h b/engines/sci/sfx/iterator_internal.h
index 00044b8ab7..faf06726b0 100644
--- a/engines/sci/sfx/iterator_internal.h
+++ b/engines/sci/sfx/iterator_internal.h
@@ -38,20 +38,20 @@ namespace Sci {
enum {
SI_STATE_UNINITIALISED = -1,
- SI_STATE_DELTA_TIME = 0, //!< Now at a delta time
- SI_STATE_COMMAND = 1, //!< Now at a MIDI operation
- SI_STATE_PENDING = 2, //!< Pending for loop
- SI_STATE_FINISHED = 3, //!< End of song
- SI_STATE_PCM = 4, //!< Should report a PCM next (-> DELTA_TIME)
- SI_STATE_PCM_MAGIC_DELTA = 5 //!< Should report a ``magic'' one tick delta time next (goes on to FINISHED)
+ SI_STATE_DELTA_TIME = 0, ///< Now at a delta time
+ SI_STATE_COMMAND = 1, ///< Now at a MIDI operation
+ SI_STATE_PENDING = 2, ///< Pending for loop
+ SI_STATE_FINISHED = 3, ///< End of song
+ SI_STATE_PCM = 4, ///< Should report a PCM next (-> DELTA_TIME)
+ SI_STATE_PCM_MAGIC_DELTA = 5 ///< Should report a ``magic'' one tick delta time next (goes on to FINISHED)
};
struct SongIteratorChannel {
- int state; //!< State of this song iterator channel
- int offset; //!< Offset into the data chunk */
- int end; //!< Last allowed byte in track */
- int id; //!< Some channel ID */
+ int state; ///< State of this song iterator channel
+ int offset; ///< Offset into the data chunk */
+ int end; ///< Last allowed byte in track */
+ int id; ///< Some channel ID */
/**
* Number of ticks before the specified channel is next used, or
@@ -64,14 +64,14 @@ struct SongIteratorChannel {
int loop_offset;
int initial_offset;
- int playmask; //!< Active playmask (MIDI channels to play in here) */
- int notes_played; //!< #of notes played since the last loop start */
- int loop_timepos; //!< Total delay for this channel's loop marker */
- int total_timepos; //!< Number of ticks since the beginning, ignoring loops */
- int timepos_increment; //!< Number of ticks until the next command (to add) */
+ int playmask; ///< Active playmask (MIDI channels to play in here) */
+ int notes_played; ///< #of notes played since the last loop start */
+ int loop_timepos; ///< Total delay for this channel's loop marker */
+ int total_timepos; ///< Number of ticks since the beginning, ignoring loops */
+ int timepos_increment; ///< Number of ticks until the next command (to add) */
- int saw_notes; //!< Bitmask of channels we have currently played notes on */
- byte last_cmd; //!< Last operation executed, for running status */
+ int saw_notes; ///< Bitmask of channels we have currently played notes on */
+ byte last_cmd; ///< Last operation executed, for running status */
public:
void init(int id, int offset, int end);
@@ -80,17 +80,17 @@ public:
class BaseSongIterator : public SongIterator {
public:
- int _polyphony[MIDI_CHANNELS]; //!< # of simultaneous notes on each
- int _importance[MIDI_CHANNELS]; //!< priority rating for each channel, 0 means unrated.
+ int _polyphony[MIDI_CHANNELS]; ///< # of simultaneous notes on each
+ int _importance[MIDI_CHANNELS]; ///< priority rating for each channel, 0 means unrated.
- int _ccc; //!< Cumulative cue counter, for those who need it
- byte _resetflag; //!< for 0x4C -- on DoSound StopSound, do we return to start?
- int _deviceId; //!< ID of the device we generating events for
- int _numActiveChannels; //!< Number of active channels
- Common::Array<byte> _data; //!< Song data
+ int _ccc; ///< Cumulative cue counter, for those who need it
+ byte _resetflag; ///< for 0x4C -- on DoSound StopSound, do we return to start?
+ int _deviceId; ///< ID of the device we generating events for
+ int _numActiveChannels; ///< Number of active channels
+ Common::Array<byte> _data; ///< Song data
- int _loops; //!< Number of loops remaining
+ int _loops; ///< Number of loops remaining
public:
BaseSongIterator(byte *data, uint size, songit_id_t id);
diff --git a/engines/scumm/smush/channel.h b/engines/scumm/smush/channel.h
index 1e023e08ff..b873bbdb30 100644
--- a/engines/scumm/smush/channel.h
+++ b/engines/scumm/smush/channel.h
@@ -36,13 +36,13 @@ namespace Scumm {
class SmushChannel {
protected:
- int32 _track; //!< the track number
- byte *_tbuffer; //!< data temporary buffer
- int32 _tbufferSize; //!< temporary buffer size
- byte *_sbuffer; //!< sound buffer
- int32 _sbufferSize; //!< sound buffer size
+ int32 _track; ///< the track number
+ byte *_tbuffer; ///< data temporary buffer
+ int32 _tbufferSize; ///< temporary buffer size
+ byte *_sbuffer; ///< sound buffer
+ int32 _sbufferSize; ///< sound buffer size
- int32 _dataSize; //!< remaining size of sound data in the iMUS buffer
+ int32 _dataSize; ///< remaining size of sound data in the iMUS buffer
bool _inData;
@@ -100,9 +100,9 @@ class ImuseChannel : public SmushChannel {
private:
int32 _srbufferSize;
- int32 _bitsize; //!< the bitsize of the original data
- int32 _rate; //!< the sampling rate of the original data
- int32 _channels; //!< the number of channels of the original data
+ int32 _bitsize; ///< the bitsize of the original data
+ int32 _rate; ///< the sampling rate of the original data
+ int32 _channels; ///< the number of channels of the original data
protected:
void decode();
diff --git a/engines/tinsel/actors.cpp b/engines/tinsel/actors.cpp
index 6b7809e52b..284e166899 100644
--- a/engines/tinsel/actors.cpp
+++ b/engines/tinsel/actors.cpp
@@ -56,9 +56,9 @@ namespace Tinsel {
/** actor struct - one per actor */
struct T1_ACTOR_STRUC {
- int32 masking; //!< type of actor masking
- SCNHANDLE hActorId; //!< handle actor ID string index
- SCNHANDLE hActorCode; //!< handle to actor script
+ int32 masking; ///< type of actor masking
+ SCNHANDLE hActorId; ///< handle actor ID string index
+ SCNHANDLE hActorCode; ///< handle to actor script
} PACKED_STRUCT;
struct T2_ACTOR_STRUC {
diff --git a/engines/tinsel/actors.h b/engines/tinsel/actors.h
index 02976acaed..0cf77e8be1 100644
--- a/engines/tinsel/actors.h
+++ b/engines/tinsel/actors.h
@@ -145,8 +145,8 @@ struct SAVED_ACTOR {
short zFactor;
bool bAlive;
bool bHidden;
- SCNHANDLE presFilm; //!< the film that reel belongs to
- short presRnum; //!< the present reel number
+ SCNHANDLE presFilm; ///< the film that reel belongs to
+ short presRnum; ///< the present reel number
short presPlayX, presPlayY;
};
typedef SAVED_ACTOR *PSAVED_ACTOR;
diff --git a/engines/tinsel/anim.h b/engines/tinsel/anim.h
index 6022edfc08..97065f6a54 100644
--- a/engines/tinsel/anim.h
+++ b/engines/tinsel/anim.h
@@ -35,11 +35,11 @@ struct OBJECT;
/** animation structure */
struct ANIM {
- int aniRate; //!< animation speed
- int aniDelta; //!< animation speed delta counter
- OBJECT *pObject; //!< object to animate (assumed to be multi-part)
- uint32 hScript; //!< animation script handle
- int scriptIndex; //!< current position in animation script
+ int aniRate; ///< animation speed
+ int aniDelta; ///< animation speed delta counter
+ OBJECT *pObject; ///< object to animate (assumed to be multi-part)
+ uint32 hScript; ///< animation script handle
+ int scriptIndex; ///< current position in animation script
};
typedef ANIM *PANIM;
@@ -47,25 +47,25 @@ typedef void (*PANI_ADDR)(struct ANIM *);
/** Animation script commands */
enum {
- ANI_END = 0, //!< end of animation script
- ANI_JUMP = 1, //!< animation script jump
- ANI_HFLIP = 2, //!< flip animated object horizontally
- ANI_VFLIP = 3, //!< flip animated object vertically
- ANI_HVFLIP = 4, //!< flip animated object in both directions
- ANI_ADJUSTX = 5, //!< adjust animated object x animation point
- ANI_ADJUSTY = 6, //!< adjust animated object y animation point
- ANI_ADJUSTXY = 7, //!< adjust animated object x & y animation points
- ANI_NOSLEEP = 8, //!< do not sleep for this frame
- ANI_CALL = 9, //!< call routine
- ANI_HIDE = 10, //!< hide animated object
- ANI_STOP = 11 //!< stop sound
+ ANI_END = 0, ///< end of animation script
+ ANI_JUMP = 1, ///< animation script jump
+ ANI_HFLIP = 2, ///< flip animated object horizontally
+ ANI_VFLIP = 3, ///< flip animated object vertically
+ ANI_HVFLIP = 4, ///< flip animated object in both directions
+ ANI_ADJUSTX = 5, ///< adjust animated object x animation point
+ ANI_ADJUSTY = 6, ///< adjust animated object y animation point
+ ANI_ADJUSTXY = 7, ///< adjust animated object x & y animation points
+ ANI_NOSLEEP = 8, ///< do not sleep for this frame
+ ANI_CALL = 9, ///< call routine
+ ANI_HIDE = 10, ///< hide animated object
+ ANI_STOP = 11 ///< stop sound
};
/** animation script command possibilities */
union ANI_SCRIPT {
- int32 op; //!< treat as an opcode or operand
- uint32 hFrame; //!< treat as a animation frame handle
-// PANI_ADDR pFunc; //!< treat as a animation function call
+ int32 op; ///< treat as an opcode or operand
+ uint32 hFrame; ///< treat as a animation frame handle
+// PANI_ADDR pFunc; ///< treat as a animation function call
};
diff --git a/engines/tinsel/background.h b/engines/tinsel/background.h
index b3599d77ae..e6074f7bb4 100644
--- a/engines/tinsel/background.h
+++ b/engines/tinsel/background.h
@@ -49,26 +49,26 @@ enum {
/** background playfield structure - a playfield is a container for modules */
struct PLAYFIELD {
- OBJECT *pDispList; //!< object display list for this playfield
- frac_t fieldX; //!< current world x position of playfield
- frac_t fieldY; //!< current world y position of playfield
- frac_t fieldXvel; //!< current x velocity of playfield
- frac_t fieldYvel; //!< current y velocity of playfield
- Common::Rect rcClip; //!< clip rectangle for this playfield
- bool bMoved; //!< set when playfield has moved
+ OBJECT *pDispList; ///< object display list for this playfield
+ frac_t fieldX; ///< current world x position of playfield
+ frac_t fieldY; ///< current world y position of playfield
+ frac_t fieldXvel; ///< current x velocity of playfield
+ frac_t fieldYvel; ///< current y velocity of playfield
+ Common::Rect rcClip; ///< clip rectangle for this playfield
+ bool bMoved; ///< set when playfield has moved
};
/** multi-playfield background structure - a backgnd is a container of playfields */
struct BACKGND {
- COLORREF rgbSkyColour; //!< background sky colour
- Common::Point ptInitWorld; //!< initial world position
- Common::Rect rcScrollLimits; //!< scroll limits
- int refreshRate; //!< background update process refresh rate
- frac_t *pXscrollTable; //!< pointer to x direction scroll table for this background
- frac_t *pYscrollTable; //!< pointer to y direction scroll table for this background
- int numPlayfields; //!< number of playfields for this background
- PLAYFIELD *fieldArray; //!< pointer to array of all playfields for this background
- bool bAutoErase; //!< when set - screen is cleared before anything is plotted (unused)
+ COLORREF rgbSkyColour; ///< background sky colour
+ Common::Point ptInitWorld; ///< initial world position
+ Common::Rect rcScrollLimits; ///< scroll limits
+ int refreshRate; ///< background update process refresh rate
+ frac_t *pXscrollTable; ///< pointer to x direction scroll table for this background
+ frac_t *pYscrollTable; ///< pointer to y direction scroll table for this background
+ int numPlayfields; ///< number of playfields for this background
+ PLAYFIELD *fieldArray; ///< pointer to array of all playfields for this background
+ bool bAutoErase; ///< when set - screen is cleared before anything is plotted (unused)
};
diff --git a/engines/tinsel/dialogs.cpp b/engines/tinsel/dialogs.cpp
index 9550500867..3fdfb0ce41 100644
--- a/engines/tinsel/dialogs.cpp
+++ b/engines/tinsel/dialogs.cpp
@@ -507,16 +507,16 @@ static bool bRemember;
enum BTYPE {
- RGROUP, //!< Radio button group - 1 is selectable at a time. Action on double click
- ARSBUT, //!< Action if a radio button is selected
- AABUT, //!< Action always
- AATBUT, //!< Action always, text box
+ RGROUP, ///< Radio button group - 1 is selectable at a time. Action on double click
+ ARSBUT, ///< Action if a radio button is selected
+ AABUT, ///< Action always
+ AATBUT, ///< Action always, text box
ARSGBUT,
- AAGBUT, //!< Action always, graphic button
- SLIDER, //!< Not a button at all
- TOGGLE, //!< Discworld 1 toggle
- TOGGLE1, //!< Discworld 2 toggle type 1
- TOGGLE2, //!< Discworld 2 toggle type 2
+ AAGBUT, ///< Action always, graphic button
+ SLIDER, ///< Not a button at all
+ TOGGLE, ///< Discworld 1 toggle
+ TOGGLE1, ///< Discworld 2 toggle type 1
+ TOGGLE2, ///< Discworld 2 toggle type 2
DCTEST,
FLIP,
FRGROUP,
diff --git a/engines/tinsel/handle.cpp b/engines/tinsel/handle.cpp
index 93536fd4e5..4ec398fa40 100644
--- a/engines/tinsel/handle.cpp
+++ b/engines/tinsel/handle.cpp
@@ -58,25 +58,25 @@ bool bLockedScene = 0;
//----------------- LOCAL DEFINES --------------------
struct MEMHANDLE {
- char szName[12]; //!< 00 - file name of graphics file
- int32 filesize; //!< 12 - file size and flags
- MEM_NODE *pNode; //!< 16 - memory node for the graphics
+ char szName[12]; ///< 00 - file name of graphics file
+ int32 filesize; ///< 12 - file size and flags
+ MEM_NODE *pNode; ///< 16 - memory node for the graphics
uint32 flags2;
};
/** memory allocation flags - stored in the top bits of the filesize field */
enum {
- fPreload = 0x01000000L, //!< preload memory
- fDiscard = 0x02000000L, //!< discard memory
- fSound = 0x04000000L, //!< sound data
- fGraphic = 0x08000000L, //!< graphic data
- fCompressed = 0x10000000L, //!< compressed data
- fLoaded = 0x20000000L //!< set when file data has been loaded
+ fPreload = 0x01000000L, ///< preload memory
+ fDiscard = 0x02000000L, ///< discard memory
+ fSound = 0x04000000L, ///< sound data
+ fGraphic = 0x08000000L, ///< graphic data
+ fCompressed = 0x10000000L, ///< compressed data
+ fLoaded = 0x20000000L ///< set when file data has been loaded
};
-#define FSIZE_MASK 0x00FFFFFFL //!< mask to isolate the filesize
-#define MALLOC_MASK 0xFF000000L //!< mask to isolate the memory allocation flags
-//#define HANDLEMASK 0xFF800000L //!< get handle of address
+#define FSIZE_MASK 0x00FFFFFFL ///< mask to isolate the filesize
+#define MALLOC_MASK 0xFF000000L ///< mask to isolate the memory allocation flags
+//#define HANDLEMASK 0xFF800000L ///< get handle of address
//----------------- LOCAL GLOBAL DATA --------------------
diff --git a/engines/tinsel/multiobj.h b/engines/tinsel/multiobj.h
index 79984f8dff..b94d63e79f 100644
--- a/engines/tinsel/multiobj.h
+++ b/engines/tinsel/multiobj.h
@@ -40,13 +40,13 @@ struct OBJECT;
* multi-object initialisation structure (parallels OBJ_INIT struct)
*/
struct MULTI_INIT {
- SCNHANDLE hMulFrame; //!< multi-objects shape - NULL terminated list of IMAGE structures
- int32 mulFlags; //!< multi-objects flags
- int32 mulID; //!< multi-objects id
- int32 mulX; //!< multi-objects initial x ani position
- int32 mulY; //!< multi-objects initial y ani position
- int32 mulZ; //!< multi-objects initial z position
- uint32 otherFlags; //!< multi-objects Tinsel 2 - other flags
+ SCNHANDLE hMulFrame; ///< multi-objects shape - NULL terminated list of IMAGE structures
+ int32 mulFlags; ///< multi-objects flags
+ int32 mulID; ///< multi-objects id
+ int32 mulX; ///< multi-objects initial x ani position
+ int32 mulY; ///< multi-objects initial y ani position
+ int32 mulZ; ///< multi-objects initial z position
+ uint32 otherFlags; ///< multi-objects Tinsel 2 - other flags
} PACKED_STRUCT;
typedef MULTI_INIT *PMULTI_INIT;
diff --git a/engines/tinsel/object.h b/engines/tinsel/object.h
index 3dafcb3522..88854502e7 100644
--- a/engines/tinsel/object.h
+++ b/engines/tinsel/object.h
@@ -40,17 +40,17 @@ enum {
NUM_OBJECTS = 256,
// object flags
- DMA_WNZ = 0x0001, //!< write non-zero data
- DMA_CNZ = 0x0002, //!< write constant on non-zero data
- DMA_CONST = 0x0004, //!< write constant on both zero & non-zero data
- DMA_WA = 0x0008, //!< write all data
- DMA_FLIPH = 0x0010, //!< flip object horizontally
- DMA_FLIPV = 0x0020, //!< flip object vertically
- DMA_CLIP = 0x0040, //!< clip object
- DMA_TRANS = 0x0084, //!< translucent rectangle object
- DMA_ABS = 0x0100, //!< position of object is absolute
- DMA_CHANGED = 0x0200, //!< object has changed in some way since the last frame
- DMA_USERDEF = 0x0400, //!< user defined flags start here
+ DMA_WNZ = 0x0001, ///< write non-zero data
+ DMA_CNZ = 0x0002, ///< write constant on non-zero data
+ DMA_CONST = 0x0004, ///< write constant on both zero & non-zero data
+ DMA_WA = 0x0008, ///< write all data
+ DMA_FLIPH = 0x0010, ///< flip object horizontally
+ DMA_FLIPV = 0x0020, ///< flip object vertically
+ DMA_CLIP = 0x0040, ///< clip object
+ DMA_TRANS = 0x0084, ///< translucent rectangle object
+ DMA_ABS = 0x0100, ///< position of object is absolute
+ DMA_CHANGED = 0x0200, ///< object has changed in some way since the last frame
+ DMA_USERDEF = 0x0400, ///< user defined flags start here
DMA_GHOST = 0x0080,
@@ -61,12 +61,12 @@ enum {
/** structure for image */
#include "common/pack-start.h" // START STRUCT PACKING
struct IMAGE {
- short imgWidth; //!< image width
- unsigned short imgHeight; //!< image height
- short anioffX; //!< image x animation offset
- short anioffY; //!< image y animation offset
- SCNHANDLE hImgBits; //!< image bitmap handle
- SCNHANDLE hImgPal; //!< image palette handle
+ short imgWidth; ///< image width
+ unsigned short imgHeight; ///< image height
+ short anioffX; ///< image x animation offset
+ short anioffY; ///< image y animation offset
+ SCNHANDLE hImgBits; ///< image bitmap handle
+ SCNHANDLE hImgPal; ///< image palette handle
} PACKED_STRUCT;
#include "common/pack-end.h" // END STRUCT PACKING
@@ -76,25 +76,25 @@ typedef uint32 FRAME;
// object structure
struct OBJECT {
- OBJECT *pNext; //!< pointer to next object in list
- OBJECT *pSlave; //!< pointer to slave object (multi-part objects)
-// char *pOnDispList; //!< pointer to display list byte for background objects
-// frac_t xVel; //!< x velocity of object
-// frac_t yVel; //!< y velocity of object
- frac_t xPos; //!< x position of object
- frac_t yPos; //!< y position of object
- int zPos; //!< z position of object
- Common::Rect rcPrev; //!< previous screen coordinates of object bounding rectangle
- int flags; //!< object flags - see above for list
- PALQ *pPal; //!< objects palette Q position
- int constant; //!< which colour in palette for monochrome objects
- int width; //!< width of object
- int height; //!< height of object
- SCNHANDLE hBits; //!< image bitmap handle
- SCNHANDLE hImg; //!< handle to object image definition
- SCNHANDLE hShape; //!< objects current animation frame
- SCNHANDLE hMirror; //!< objects previous animation frame
- int oid; //!< object identifier
+ OBJECT *pNext; ///< pointer to next object in list
+ OBJECT *pSlave; ///< pointer to slave object (multi-part objects)
+// char *pOnDispList; ///< pointer to display list byte for background objects
+// frac_t xVel; ///< x velocity of object
+// frac_t yVel; ///< y velocity of object
+ frac_t xPos; ///< x position of object
+ frac_t yPos; ///< y position of object
+ int zPos; ///< z position of object
+ Common::Rect rcPrev; ///< previous screen coordinates of object bounding rectangle
+ int flags; ///< object flags - see above for list
+ PALQ *pPal; ///< objects palette Q position
+ int constant; ///< which colour in palette for monochrome objects
+ int width; ///< width of object
+ int height; ///< height of object
+ SCNHANDLE hBits; ///< image bitmap handle
+ SCNHANDLE hImg; ///< handle to object image definition
+ SCNHANDLE hShape; ///< objects current animation frame
+ SCNHANDLE hMirror; ///< objects previous animation frame
+ int oid; ///< object identifier
};
typedef OBJECT *POBJECT;
diff --git a/engines/tinsel/palette.cpp b/engines/tinsel/palette.cpp
index 8918aa47e6..a6e0a81406 100644
--- a/engines/tinsel/palette.cpp
+++ b/engines/tinsel/palette.cpp
@@ -40,12 +40,12 @@ namespace Tinsel {
/** video DAC transfer Q structure */
struct VIDEO_DAC_Q {
union {
- SCNHANDLE hRGBarray; //!< handle of palette or
- COLORREF *pRGBarray; //!< list of palette colours
+ SCNHANDLE hRGBarray; ///< handle of palette or
+ COLORREF *pRGBarray; ///< list of palette colours
} pal;
- bool bHandle; //!< when set - use handle of palette
- int destDACindex; //!< start index of palette in video DAC
- int numColours; //!< number of colours in "hRGBarray"
+ bool bHandle; ///< when set - use handle of palette
+ int destDACindex; ///< start index of palette in video DAC
+ int numColours; ///< number of colours in "hRGBarray"
};
diff --git a/engines/tinsel/palette.h b/engines/tinsel/palette.h
index d5b64ae11f..1fb34a0782 100644
--- a/engines/tinsel/palette.h
+++ b/engines/tinsel/palette.h
@@ -42,18 +42,18 @@ typedef uint32 COLORREF;
#define TINSEL_PSX_RGB(r,g,b) ((uint16)(((uint8)(r))|((uint16)(g)<<5)|(((uint16)(b))<<10)))
enum {
- MAX_COLOURS = 256, //!< maximum number of colours - for VGA 256
- BITS_PER_PIXEL = 8, //!< number of bits per pixel for VGA 256
- MAX_INTENSITY = 255, //!< the biggest value R, G or B can have
- NUM_PALETTES = 32, //!< number of palettes
+ MAX_COLOURS = 256, ///< maximum number of colours - for VGA 256
+ BITS_PER_PIXEL = 8, ///< number of bits per pixel for VGA 256
+ MAX_INTENSITY = 255, ///< the biggest value R, G or B can have
+ NUM_PALETTES = 32, ///< number of palettes
// Discworld has some fixed apportioned bits in the palette.
- BGND_DAC_INDEX = 0, //!< index of background colour in Video DAC
- FGND_DAC_INDEX = 1, //!< index of first foreground colour in Video DAC
- TBLUE1 = 228, //!< Blue used in translucent rectangles
- TBLUE2 = 229, //!< Blue used in translucent rectangles
- TBLUE3 = 230, //!< Blue used in translucent rectangles
- TBLUE4 = 231, //!< Blue used in translucent rectangles
+ BGND_DAC_INDEX = 0, ///< index of background colour in Video DAC
+ FGND_DAC_INDEX = 1, ///< index of first foreground colour in Video DAC
+ TBLUE1 = 228, ///< Blue used in translucent rectangles
+ TBLUE2 = 229, ///< Blue used in translucent rectangles
+ TBLUE3 = 230, ///< Blue used in translucent rectangles
+ TBLUE4 = 231, ///< Blue used in translucent rectangles
TALKFONT_COL = 233
};
@@ -73,8 +73,8 @@ enum {
/** hardware palette structure */
struct PALETTE {
- int32 numColours; //!< number of colours in the palette
- COLORREF palRGB[MAX_COLOURS]; //!< actual palette colours
+ int32 numColours; ///< number of colours in the palette
+ COLORREF palRGB[MAX_COLOURS]; ///< actual palette colours
} PACKED_STRUCT;
#include "common/pack-end.h" // END STRUCT PACKING
@@ -82,10 +82,10 @@ struct PALETTE {
/** palette queue structure */
struct PALQ {
- SCNHANDLE hPal; //!< handle to palette data struct
- int objCount; //!< number of objects using this palette
- int posInDAC; //!< palette position in the video DAC
- int numColours; //!< number of colours in the palette
+ SCNHANDLE hPal; ///< handle to palette data struct
+ int objCount; ///< number of objects using this palette
+ int posInDAC; ///< palette position in the video DAC
+ int numColours; ///< number of colours in the palette
// Discworld 2 fields
bool bFading; // Whether or not fading
COLORREF palRGB[MAX_COLOURS]; // actual palette colours
diff --git a/engines/tinsel/pcode.cpp b/engines/tinsel/pcode.cpp
index 448972b7ed..63806a4d30 100644
--- a/engines/tinsel/pcode.cpp
+++ b/engines/tinsel/pcode.cpp
@@ -48,57 +48,57 @@ extern int CallLibraryRoutine(CORO_PARAM, int operand, int32 *pp, const INT_CONT
/** list of all opcodes */
enum OPCODE {
- OP_HALT = 0, //!< end of program
- OP_IMM = 1, //!< loads signed immediate onto stack
- OP_ZERO = 2, //!< loads zero onto stack
- OP_ONE = 3, //!< loads one onto stack
- OP_MINUSONE = 4, //!< loads minus one onto stack
- OP_STR = 5, //!< loads string offset onto stack
- OP_FILM = 6, //!< loads film offset onto stack
- OP_FONT = 7, //!< loads font offset onto stack
- OP_PAL = 8, //!< loads palette offset onto stack
- OP_LOAD = 9, //!< loads local variable onto stack
- OP_GLOAD = 10, //!< loads global variable onto stack - long offset to variable
- OP_STORE = 11, //!< pops stack and stores in local variable - long offset to variable
- OP_GSTORE = 12, //!< pops stack and stores in global variable - long offset to variable
- OP_CALL = 13, //!< procedure call
- OP_LIBCALL = 14, //!< library procedure call - long offset to procedure
- OP_RET = 15, //!< procedure return
- OP_ALLOC = 16, //!< allocate storage on stack
- OP_JUMP = 17, //!< unconditional jump - signed word offset
- OP_JMPFALSE = 18, //!< conditional jump - signed word offset
- OP_JMPTRUE = 19, //!< conditional jump - signed word offset
- OP_EQUAL = 20, //!< tests top two items on stack for equality
- OP_LESS, //!< tests top two items on stack
- OP_LEQUAL, //!< tests top two items on stack
- OP_NEQUAL, //!< tests top two items on stack
- OP_GEQUAL, //!< tests top two items on stack
- OP_GREAT = 25, //!< tests top two items on stack
- OP_PLUS, //!< adds top two items on stack and replaces with result
- OP_MINUS, //!< subs top two items on stack and replaces with result
- OP_LOR, //!< logical or of top two items on stack and replaces with result
- OP_MULT, //!< multiplies top two items on stack and replaces with result
- OP_DIV = 30, //!< divides top two items on stack and replaces with result
- OP_MOD, //!< divides top two items on stack and replaces with modulus
- OP_AND, //!< bitwise ands top two items on stack and replaces with result
- OP_OR, //!< bitwise ors top two items on stack and replaces with result
- OP_EOR, //!< bitwise exclusive ors top two items on stack and replaces with result
- OP_LAND = 35, //!< logical ands top two items on stack and replaces with result
- OP_NOT, //!< logical nots top item on stack
- OP_COMP, //!< complements top item on stack
- OP_NEG, //!< negates top item on stack
- OP_DUP, //!< duplicates top item on stack
- OP_ESCON = 40, //!< start of escapable sequence
- OP_ESCOFF = 41, //!< end of escapable sequence
- OP_CIMM, //!< loads signed immediate onto stack (special to case statements)
- OP_CDFILM //!< loads film offset onto stack but not in current scene
+ OP_HALT = 0, ///< end of program
+ OP_IMM = 1, ///< loads signed immediate onto stack
+ OP_ZERO = 2, ///< loads zero onto stack
+ OP_ONE = 3, ///< loads one onto stack
+ OP_MINUSONE = 4, ///< loads minus one onto stack
+ OP_STR = 5, ///< loads string offset onto stack
+ OP_FILM = 6, ///< loads film offset onto stack
+ OP_FONT = 7, ///< loads font offset onto stack
+ OP_PAL = 8, ///< loads palette offset onto stack
+ OP_LOAD = 9, ///< loads local variable onto stack
+ OP_GLOAD = 10, ///< loads global variable onto stack - long offset to variable
+ OP_STORE = 11, ///< pops stack and stores in local variable - long offset to variable
+ OP_GSTORE = 12, ///< pops stack and stores in global variable - long offset to variable
+ OP_CALL = 13, ///< procedure call
+ OP_LIBCALL = 14, ///< library procedure call - long offset to procedure
+ OP_RET = 15, ///< procedure return
+ OP_ALLOC = 16, ///< allocate storage on stack
+ OP_JUMP = 17, ///< unconditional jump - signed word offset
+ OP_JMPFALSE = 18, ///< conditional jump - signed word offset
+ OP_JMPTRUE = 19, ///< conditional jump - signed word offset
+ OP_EQUAL = 20, ///< tests top two items on stack for equality
+ OP_LESS, ///< tests top two items on stack
+ OP_LEQUAL, ///< tests top two items on stack
+ OP_NEQUAL, ///< tests top two items on stack
+ OP_GEQUAL, ///< tests top two items on stack
+ OP_GREAT = 25, ///< tests top two items on stack
+ OP_PLUS, ///< adds top two items on stack and replaces with result
+ OP_MINUS, ///< subs top two items on stack and replaces with result
+ OP_LOR, ///< logical or of top two items on stack and replaces with result
+ OP_MULT, ///< multiplies top two items on stack and replaces with result
+ OP_DIV = 30, ///< divides top two items on stack and replaces with result
+ OP_MOD, ///< divides top two items on stack and replaces with modulus
+ OP_AND, ///< bitwise ands top two items on stack and replaces with result
+ OP_OR, ///< bitwise ors top two items on stack and replaces with result
+ OP_EOR, ///< bitwise exclusive ors top two items on stack and replaces with result
+ OP_LAND = 35, ///< logical ands top two items on stack and replaces with result
+ OP_NOT, ///< logical nots top item on stack
+ OP_COMP, ///< complements top item on stack
+ OP_NEG, ///< negates top item on stack
+ OP_DUP, ///< duplicates top item on stack
+ OP_ESCON = 40, ///< start of escapable sequence
+ OP_ESCOFF = 41, ///< end of escapable sequence
+ OP_CIMM, ///< loads signed immediate onto stack (special to case statements)
+ OP_CDFILM ///< loads film offset onto stack but not in current scene
};
// modifiers for the above opcodes
-#define OPSIZE8 0x40 //!< when this bit is set - the operand size is 8 bits
-#define OPSIZE16 0x80 //!< when this bit is set - the operand size is 16 bits
+#define OPSIZE8 0x40 ///< when this bit is set - the operand size is 8 bits
+#define OPSIZE16 0x80 ///< when this bit is set - the operand size is 16 bits
-#define OPMASK 0x3F //!< mask to isolate the opcode
+#define OPMASK 0x3F ///< mask to isolate the opcode
bool bNoPause = false;
diff --git a/engines/tinsel/pcode.h b/engines/tinsel/pcode.h
index 02a091e617..81feb5c241 100644
--- a/engines/tinsel/pcode.h
+++ b/engines/tinsel/pcode.h
@@ -44,7 +44,7 @@ enum RESUME_STATE {
};
enum {
- PCODE_STACK_SIZE = 128 //!< interpeters stack size
+ PCODE_STACK_SIZE = 128 ///< interpeters stack size
};
enum GSORT {
@@ -68,25 +68,25 @@ struct WorkaroundEntry {
struct INT_CONTEXT {
// Elements for interpret context management
- PROCESS *pProc; //!< processes owning this context
- GSORT GSort; //!< sort of this context
+ PROCESS *pProc; ///< processes owning this context
+ GSORT GSort; ///< sort of this context
// Previously parameters to Interpret()
- SCNHANDLE hCode; //!< scene handle of the code to execute
- byte *code; //!< pointer to the code to execute
- TINSEL_EVENT event; //!< causal event
- HPOLYGON hPoly; //!< associated polygon (if any)
- int idActor; //!< associated actor (if any)
- INV_OBJECT *pinvo; //!< associated inventory object
+ SCNHANDLE hCode; ///< scene handle of the code to execute
+ byte *code; ///< pointer to the code to execute
+ TINSEL_EVENT event; ///< causal event
+ HPOLYGON hPoly; ///< associated polygon (if any)
+ int idActor; ///< associated actor (if any)
+ INV_OBJECT *pinvo; ///< associated inventory object
// Previously local variables in Interpret()
- int32 stack[PCODE_STACK_SIZE]; //!< interpeters run time stack
- int sp; //!< stack pointer
- int bp; //!< base pointer
- int ip; //!< instruction pointer
- bool bHalt; //!< set to exit interpeter
+ int32 stack[PCODE_STACK_SIZE]; ///< interpeters run time stack
+ int sp; ///< stack pointer
+ int bp; ///< base pointer
+ int ip; ///< instruction pointer
+ bool bHalt; ///< set to exit interpeter
bool escOn;
- int myEscape; //!< only initialised to prevent compiler warning!
+ int myEscape; ///< only initialised to prevent compiler warning!
uint32 waitNumber1; // The waiting numbert
uint32 waitNumber2; // The wait for number
diff --git a/engines/tinsel/polygons.cpp b/engines/tinsel/polygons.cpp
index 53358aa9a2..5d9cac1a76 100644
--- a/engines/tinsel/polygons.cpp
+++ b/engines/tinsel/polygons.cpp
@@ -123,10 +123,10 @@ struct LINEINFO {
int32 b;
int32 c;
- int32 a2; //!< a squared
- int32 b2; //!< b squared
- int32 a2pb2; //!< a squared + b squared
- int32 ra2pb2; //!< root(a squared + b squared)
+ int32 a2; ///< a squared
+ int32 b2; ///< b squared
+ int32 a2pb2; ///< a squared + b squared
+ int32 ra2pb2; ///< root(a squared + b squared)
int32 ab;
int32 ac;
@@ -165,7 +165,7 @@ public:
LINEINFO *getLineinfo(int i) const { return ((LINEINFO *)(_pStart + (int)FROM_LE_32(plinelist))) + i; }
protected:
- POLY_TYPE type; //!< type of polygon
+ POLY_TYPE type; ///< type of polygon
public:
int32 x[4], y[4]; // Polygon definition
uint32 xoff, yoff; // DW2 - polygon offset
@@ -174,9 +174,9 @@ public:
SCNHANDLE hTagtext; // } i.e. EXIT, TAG, EFFECT
int32 nodex, nodey; // EXIT, TAG, REFER
- SCNHANDLE hFilm; //!< film reel handle for EXIT, TAG
+ SCNHANDLE hFilm; ///< film reel handle for EXIT, TAG
- int32 reftype; //!< Type of REFER
+ int32 reftype; ///< Type of REFER
int32 id; // } EXIT and TAG
@@ -187,15 +187,15 @@ public:
int32 zFactor; // }
protected:
- int32 nodecount; //!<The number of nodes in this polygon
- int32 pnodelistx, pnodelisty; //!<offset in chunk to this array if present
+ int32 nodecount; ///<The number of nodes in this polygon
+ int32 pnodelistx, pnodelisty; ///<offset in chunk to this array if present
int32 plinelist;
int32 *nlistx;
int32 *nlisty;
public:
- SCNHANDLE hScript; //!< handle of code segment for polygon events
+ SCNHANDLE hScript; ///< handle of code segment for polygon events
};
Poly::Poly(const byte *pSrc) : _pStart(pSrc) {
@@ -610,10 +610,10 @@ void FindBestPoint(HPOLYGON hp, int *x, int *y, int *pline) {
// One bad thing: We use sqrt to compute a square root. Might not be a good idea,
// speed wise. Maybe we should take Vicent's fp_sqroot. But that's a problem for later.
- int32 a2 = (int)FROM_LE_32(line->a2); //!< a squared
- int32 b2 = (int)FROM_LE_32(line->b2); //!< b squared
- int32 a2pb2 = (int)FROM_LE_32(line->a2pb2); //!< a squared + b squared
- int32 ra2pb2 = (int)FROM_LE_32(line->ra2pb2); //!< root(a squared + b squared)
+ int32 a2 = (int)FROM_LE_32(line->a2); ///< a squared
+ int32 b2 = (int)FROM_LE_32(line->b2); ///< b squared
+ int32 a2pb2 = (int)FROM_LE_32(line->a2pb2); ///< a squared + b squared
+ int32 ra2pb2 = (int)FROM_LE_32(line->ra2pb2); ///< root(a squared + b squared)
int32 ab = (int)FROM_LE_32(line->ab);
int32 ac = (int)FROM_LE_32(line->ac);
diff --git a/engines/tinsel/scene.cpp b/engines/tinsel/scene.cpp
index 3f28018c71..2e35ec10c5 100644
--- a/engines/tinsel/scene.cpp
+++ b/engines/tinsel/scene.cpp
@@ -94,8 +94,8 @@ struct SCENE_STRUC {
/** entrance structure - one per entrance */
struct ENTRANCE_STRUC {
- int32 eNumber; //!< entrance number
- SCNHANDLE hScript; //!< handle to entrance script
+ int32 eNumber; ///< entrance number
+ SCNHANDLE hScript; ///< handle to entrance script
// Tinsel 2 fields
SCNHANDLE hEntDesc; // handle to entrance description
uint32 flags;
diff --git a/engines/tinsel/scene.h b/engines/tinsel/scene.h
index 8420c3f1cc..4b0029fb5f 100644
--- a/engines/tinsel/scene.h
+++ b/engines/tinsel/scene.h
@@ -33,11 +33,11 @@
namespace Tinsel {
enum {
- MAX_NODES = 32, //!< maximum nodes in a Node Path
- MAX_NOSCROLL = 16, //!< maximum number of NoScroll commands in a scene
- MAX_ENTRANCE = 25, //!< maximum number of entrances in a scene
- MAX_POLY = 256, //!< maximum number of polygons in a scene
- MAX_ACTOR = 32 //!< maximum number of actors in a scene
+ MAX_NODES = 32, ///< maximum nodes in a Node Path
+ MAX_NOSCROLL = 16, ///< maximum number of NoScroll commands in a scene
+ MAX_ENTRANCE = 25, ///< maximum number of entrances in a scene
+ MAX_POLY = 256, ///< maximum number of polygons in a scene
+ MAX_ACTOR = 32 ///< maximum number of actors in a scene
};
// ENTRANCE_STRUC bitflags
diff --git a/engines/tinsel/sched.h b/engines/tinsel/sched.h
index 07ca44bf54..8c71127cc9 100644
--- a/engines/tinsel/sched.h
+++ b/engines/tinsel/sched.h
@@ -45,15 +45,15 @@ typedef void (*CORO_ADDR)(CoroContext &, const void *);
/** process structure */
struct PROCESS {
- PROCESS *pNext; //!< pointer to next process in active or free list
- PROCESS *pPrevious; //!< pointer to previous process in active or free list
+ PROCESS *pNext; ///< pointer to next process in active or free list
+ PROCESS *pPrevious; ///< pointer to previous process in active or free list
- CoroContext state; //!< the state of the coroutine
- CORO_ADDR coroAddr; //!< the entry point of the coroutine
+ CoroContext state; ///< the state of the coroutine
+ CORO_ADDR coroAddr; ///< the entry point of the coroutine
- int sleepTime; //!< number of scheduler cycles to sleep
- int pid; //!< process ID
- char param[PARAM_SIZE]; //!< process specific info
+ int sleepTime; ///< number of scheduler cycles to sleep
+ int pid; ///< process ID
+ char param[PARAM_SIZE]; ///< process specific info
};
typedef PROCESS *PPROCESS;
diff --git a/engines/tinsel/text.h b/engines/tinsel/text.h
index 3a61eb3cfc..664f0d207c 100644
--- a/engines/tinsel/text.h
+++ b/engines/tinsel/text.h
@@ -34,10 +34,10 @@ namespace Tinsel {
/** text mode flags - defaults to left justify */
enum {
- TXT_CENTRE = 0x0001, //!< centre justify text
- TXT_RIGHT = 0x0002, //!< right justify text
- TXT_SHADOW = 0x0004, //!< shadow each character
- TXT_ABSOLUTE = 0x0008 //!< position of text is absolute (only for object text)
+ TXT_CENTRE = 0x0001, ///< centre justify text
+ TXT_RIGHT = 0x0002, ///< right justify text
+ TXT_SHADOW = 0x0004, ///< shadow each character
+ TXT_ABSOLUTE = 0x0008 ///< position of text is absolute (only for object text)
};
/** maximum number of characters in a font */
@@ -56,13 +56,13 @@ enum {
* It is currently set at 300 because it suited me for debugging.
*/
struct FONT {
- int xSpacing; //!< x spacing between characters
- int ySpacing; //!< y spacing between characters
- int xShadow; //!< x shadow offset
- int yShadow; //!< y shadow offset
- int spaceSize; //!< x spacing to use for a space character
- OBJ_INIT fontInit; //!< structure used to init text objects
- SCNHANDLE fontDef[300]; //!< image handle array for all characters in the font
+ int xSpacing; ///< x spacing between characters
+ int ySpacing; ///< y spacing between characters
+ int xShadow; ///< x shadow offset
+ int yShadow; ///< y shadow offset
+ int spaceSize; ///< x spacing to use for a space character
+ OBJ_INIT fontInit; ///< structure used to init text objects
+ SCNHANDLE fontDef[300]; ///< image handle array for all characters in the font
} PACKED_STRUCT;
#include "common/pack-end.h" // END STRUCT PACKING
@@ -70,14 +70,14 @@ struct FONT {
/** structure for passing the correct parameters to ObjectTextOut */
struct TEXTOUT {
- OBJECT *pList; //!< object list to add text to
- char *szStr; //!< string to output
- int colour; //!< colour for monochrome text
- int xPos; //!< x position of string
- int yPos; //!< y position of string
- SCNHANDLE hFont; //!< which font to use
- int mode; //!< mode flags for the string
- int sleepTime; //!< sleep time between each character (if non-zero)
+ OBJECT *pList; ///< object list to add text to
+ char *szStr; ///< string to output
+ int colour; ///< colour for monochrome text
+ int xPos; ///< x position of string
+ int yPos; ///< y position of string
+ SCNHANDLE hFont; ///< which font to use
+ int mode; ///< mode flags for the string
+ int sleepTime; ///< sleep time between each character (if non-zero)
};