thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

some cheap doxygen docs; cleanup

Browse source 
svn-id: r8154
This commit is contained in:
Max Horn 2003-05-30 20:13:29 +00:00
parent 1f38765c16
commit eb039ec554
7 changed files with 80 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

4
scumm/bomp.h
View file

@ -23,12 +23,8 @@
#define BOMP_H #define BOMP_H
int32 setupBompScale(byte *scaling, int32 size, byte scale); int32 setupBompScale(byte *scaling, int32 size, byte scale);
void bompApplyShadow(int shadowMode, const byte *shadowPalette, const byte *line_buffer, byte *dst, int32 size, byte transparency); void bompApplyShadow(int shadowMode, const byte *shadowPalette, const byte *line_buffer, byte *dst, int32 size, byte transparency);
void decompressBomp(byte *dst, const byte *src, int w, int h); void decompressBomp(byte *dst, const byte *src, int w, int h);
void bompDecodeLine(byte *dst, const byte *src, int size); void bompDecodeLine(byte *dst, const byte *src, int size);
#endif #endif

128
scumm/gfx.cpp
View file

@ -44,7 +44,7 @@ static const int8 shake_positions[NUM_SHAKE_POSITIONS] = {
0, 1 * 2, 2 * 2, 1 * 2, 0 * 2, 2 * 2, 3 * 2, 1 * 2 0, 1 * 2, 2 * 2, 1 * 2, 0 * 2, 2 * 2, 3 * 2, 1 * 2
}; };
/* /**
* The following structs define four basic fades/transitions used by * The following structs define four basic fades/transitions used by
* transitionEffect(), each looking differently to the user. * transitionEffect(), each looking differently to the user.
* Note that the stripTables contain strip numbers, and they assume * Note that the stripTables contain strip numbers, and they assume
@ -57,12 +57,12 @@ static const int8 shake_positions[NUM_SHAKE_POSITIONS] = {
* And the 25 = min(25,40). Hence for Zak256 instead of 13 and 25, the values * And the 25 = min(25,40). Hence for Zak256 instead of 13 and 25, the values
* 15 and 30 should be used, and for COMI probably 30 and 60. * 15 and 30 should be used, and for COMI probably 30 and 60.
*/ */
struct TransitionEffect { struct TransitionEffect {
byte numOfIterations; byte numOfIterations;
int8 deltaTable[16]; // four times l / t / r / b int8 deltaTable[16]; // four times l / t / r / b
byte stripTable[16]; // ditto byte stripTable[16]; // ditto
}; };
#ifdef __PALM_OS__ #ifdef __PALM_OS__
static const TransitionEffect *transitionEffects; static const TransitionEffect *transitionEffects;
#else #else
@ -386,8 +386,10 @@ void Scumm::updateDirtyScreen(int slot) {
gdi.updateDirtyScreen(&virtscr[slot]); gdi.updateDirtyScreen(&virtscr[slot]);
} }
// Blit the data from the given VirtScreen to the display. If the camera moved, /**
// a full blit is done, otherwise only the visible dirty areas are updated. * Blit the data from the given VirtScreen to the display. If the camera moved,
* a full blit is done, otherwise only the visible dirty areas are updated.
*/
void Gdi::updateDirtyScreen(VirtScreen *vs) { void Gdi::updateDirtyScreen(VirtScreen *vs) {
if (vs->height == 0) if (vs->height == 0)
return; return;
@ -426,7 +428,9 @@ void Gdi::updateDirtyScreen(VirtScreen *vs) {
} }
} }
// Blit the specified rectangle from the given virtual screen to the display. /**
* Blit the specified rectangle from the given virtual screen to the display.
*/
void Gdi::drawStripToScreen(VirtScreen *vs, int x, int w, int t, int b) { void Gdi::drawStripToScreen(VirtScreen *vs, int x, int w, int t, int b) {
byte *ptr; byte *ptr;
int height; int height;
@ -457,7 +461,9 @@ void Gdi::clearUpperMask() {
memset(_vm->getResourceAddress(rtBuffer, 9), 0, _imgBufOffs[1] - _imgBufOffs[0]); memset(_vm->getResourceAddress(rtBuffer, 9), 0, _imgBufOffs[1] - _imgBufOffs[0]);
} }
// Reset the background behind an actor or blast object /**
* Reset the background behind an actor or blast object.
*/
void Gdi::resetBackground(int top, int bottom, int strip) { void Gdi::resetBackground(int top, int bottom, int strip) {
VirtScreen *vs = &_vm->virtscr[0]; VirtScreen *vs = &_vm->virtscr[0];
byte *backbuff_ptr, *bgbak_ptr; byte *backbuff_ptr, *bgbak_ptr;
@ -702,8 +708,10 @@ void Scumm::drawFlashlight() {
_flashlight.isDrawn = true; _flashlight.isDrawn = true;
} }
// Redraw background as needed, i.e. the left/right sides if scrolling took place etc. /**
// Note that this only updated the virtual screen, not the actual display. * Redraw background as needed, i.e. the left/right sides if scrolling took place etc.
* Note that this only updated the virtual screen, not the actual display.
*/
void Scumm::redrawBGAreas() { void Scumm::redrawBGAreas() {
int i; int i;
int val; int val;
@ -861,12 +869,6 @@ bool Scumm::hasCharsetMask(int left, int top, int right, int bottom) {
&& left <= gdi._mask.right && left <= gdi._mask.right
&& bottom >= gdi._mask.top && bottom >= gdi._mask.top
&& right >= gdi._mask.left; && right >= gdi._mask.left;
/*
if (!_charset->_hasMask || top > gdi._mask_bottom || left > gdi._mask_right ||
bottom < gdi._mask_top || right < gdi._mask_left)
return false;
return true;
*/
} }
bool Scumm::isMaskActiveAt(int l, int t, int r, int b, byte *mem) { bool Scumm::isMaskActiveAt(int l, int t, int r, int b, byte *mem) {
@ -902,6 +904,10 @@ bool Scumm::isMaskActiveAt(int l, int t, int r, int b, byte *mem) {
#pragma mark --- Image drawing --- #pragma mark --- Image drawing ---
#pragma mark - #pragma mark -
/**
* Draw a bitmap onto a virtual screen. This is main drawing method for room backgrounds
* and objects, used throughout all SCUMM versions.
*/
void Gdi::drawBitmap(const byte *ptr, VirtScreen *vs, int x, int y, const int width, const int height, void Gdi::drawBitmap(const byte *ptr, VirtScreen *vs, int x, int y, const int width, const int height,
int stripnr, int numstrip, byte flag) { int stripnr, int numstrip, byte flag) {
assert(ptr); assert(ptr);
@ -1003,11 +1009,13 @@ void Gdi::drawBitmap(const byte *ptr, VirtScreen *vs, int x, int y, const int wi
if (vs->scrollable) if (vs->scrollable)
sx -= vs->xstart >> 3; sx -= vs->xstart >> 3;
////// //
////// // Since V3, all graphics data was encoded in strips, which is very efficient
////// START OF BIG HACK! // for redrawing only parts of the screen. However, V2 is different: here
////// // the whole graphics are encoded as one big chunk. That makes it rather
////// // dificult to draw only parts of a room/object. We handle the V2 graphics
// differently from all other (newer) graphic formats for this reason.
//
if (_vm->_features & GF_AFTER_V2) { if (_vm->_features & GF_AFTER_V2) {
if (vs->alloctwobuffers) if (vs->alloctwobuffers)
@ -1109,12 +1117,6 @@ void Gdi::drawBitmap(const byte *ptr, VirtScreen *vs, int x, int y, const int wi
} }
} }
//////
//////
////// END OF BIG HACK!
//////
//////
while (numstrip--) { while (numstrip--) {
CHECK_HEAP; CHECK_HEAP;
@ -1807,21 +1809,21 @@ void Gdi::unkDecodeC_trans(byte *dst, const byte *src, int height) {
#undef FILL_BITS #undef FILL_BITS
/* Ender - Zak256/Indy256 decoders */ /* Ender - Zak256/Indy256 decoders */
#define READ_256BIT \ #define READ_256BIT \
if ((mask <<= 1) == 256) { \ if ((mask <<= 1) == 256) { \
buffer = *src++; \ buffer = *src++; \
mask = 1; \ mask = 1; \
} \ } \
bits = ((buffer & mask) != 0); bits = ((buffer & mask) != 0);
#define NEXT_ROW \ #define NEXT_ROW \
dst += _vm->_screenWidth; \ dst += _vm->_screenWidth; \
if (--h == 0) { \ if (--h == 0) { \
if (!--x) \ if (!--x) \
return; \ return; \
dst -= _vertStripNextInc; \ dst -= _vertStripNextInc; \
h = height; \ h = height; \
} }
void Gdi::unkDecode7(byte *dst, const byte *src, int height) { void Gdi::unkDecode7(byte *dst, const byte *src, int height) {
uint h = height; uint h = height;
@ -1877,7 +1879,7 @@ void Gdi::unkDecode9(byte *dst, const byte *src, int height) {
c += (bits << i); c += (bits << i);
} }
switch ((c >> 2)) { switch (c >> 2) {
case 0: case 0:
color = 0; color = 0;
for (i = 0; i < 4; i++) { for (i = 0; i < 4; i++) {
@ -2068,14 +2070,15 @@ void Scumm::fadeOut(int effect) {
_screenEffectFlag = false; _screenEffectFlag = false;
} }
/* Transition effect. There are four different effects possible, /**
* indicated by the value of a: * Perform a transition effect. There are four different effects possible:
* 0: Iris effect * 0: Iris effect
* 1: Box wipe (a black box expands from the upper-left corner to the lower-right corner) * 1: Box wipe (a black box expands from the upper-left corner to the lower-right corner)
* 2: Box wipe (a black box expands from the lower-right corner to the upper-left corner) * 2: Box wipe (a black box expands from the lower-right corner to the upper-left corner)
* 3: Inverse box wipe * 3: Inverse box wipe
* All effects operate on 8x8 blocks of the screen. These blocks are updated * All effects operate on 8x8 blocks of the screen. These blocks are updated
* in a certain order; the exact order determines how the effect appears to the user. * in a certain order; the exact order determines how the effect appears to the user.
* @param a the transition effect to perform
*/ */
void Scumm::transitionEffect(int a) { void Scumm::transitionEffect(int a) {
int delta[16]; // Offset applied during each iteration int delta[16]; // Offset applied during each iteration
@ -2128,13 +2131,14 @@ void Scumm::transitionEffect(int a) {
} }
} }
// Update width x height areas of the screen, in random order, until the whole /**
// screen has been updated. For instance: * Update width*height areas of the screen, in random order, until the whole
// * screen has been updated. For instance:
// dissolveEffect(1, 1) produces a pixel-by-pixel dissolve *
// dissolveEffect(8, 8) produces a square-by-square dissolve * dissolveEffect(1, 1) produces a pixel-by-pixel dissolve
// dissolveEffect(virtsrc[0].width, 1) produces a line-by-line dissolve * dissolveEffect(8, 8) produces a square-by-square dissolve
* dissolveEffect(virtsrc[0].width, 1) produces a line-by-line dissolve
*/
void Scumm::dissolveEffect(int width, int height) { void Scumm::dissolveEffect(int width, int height) {
VirtScreen *vs = &virtscr[0]; VirtScreen *vs = &virtscr[0];
int *offsets; int *offsets;
@ -2502,8 +2506,10 @@ void Scumm::cyclePalette() {
} }
} }
// Perform color cycling on the palManipulate data, too, otherwise /**
// color cycling will be disturbed by the palette fade. * Perform color cycling on the palManipulate data, too, otherwise
* color cycling will be disturbed by the palette fade.
*/
void Scumm::moveMemInPalRes(int start, int end, byte direction) { void Scumm::moveMemInPalRes(int start, int end, byte direction) {
byte *startptr, *endptr; byte *startptr, *endptr;
byte *startptr2, *endptr2; byte *startptr2, *endptr2;
@ -2712,7 +2718,7 @@ void Scumm::setupShadowPalette(int redScale, int greenScale, int blueScale, int
} }
} }
/* Yazoo: This function create the specialPalette used for semi-transparency in SamnMax */ /** This function create the specialPalette used for semi-transparency in SamnMax */
void Scumm::createSpecialPalette(int16 from, int16 to, int16 redScale, int16 greenScale, int16 blueScale, void Scumm::createSpecialPalette(int16 from, int16 to, int16 redScale, int16 greenScale, int16 blueScale,
int16 startColor, int16 endColor) { int16 startColor, int16 endColor) {
const byte *palPtr, *curPtr; const byte *palPtr, *curPtr;
@ -2816,16 +2822,18 @@ static double value(double n1, double n2, double hue)
return n1; return n1;
} }
/**
* This function scales the HSL (Hue, Saturation and Lightness)
* components of the palette colours. It's used in CMI when Guybrush
* walks from the beach towards the swamp.
*
* I don't know if this function is correct, but the output seems to
* match the original fairly closely.
*
* @todo Rewrite desaturatePalette using integer arithmetics only?
*/
void Scumm::desaturatePalette(int hueScale, int satScale, int lightScale, int startColor, int endColor) void Scumm::desaturatePalette(int hueScale, int satScale, int lightScale, int startColor, int endColor)
{ {
// This function scales the HSL (Hue, Saturation and Lightness)
// components of the palette colours. It's used in CMI when Guybrush
// walks from the beach towards the swamp.
//
// I don't know if this function is correct, but the output seems to
// match the original fairly closely.
//
// FIXME: Rewrite using integer arithmetics only?
if (startColor <= endColor) { if (startColor <= endColor) {
const byte *cptr; const byte *cptr;

13
scumm/gfx.h
View file

@ -25,13 +25,13 @@
#include "common/rect.h" #include "common/rect.h"
enum { /* Camera modes */ enum { /** Camera modes */
CM_NORMAL = 1, CM_NORMAL = 1,
CM_FOLLOW_ACTOR = 2, CM_FOLLOW_ACTOR = 2,
CM_PANNING = 3 CM_PANNING = 3
}; };
struct CameraData { /* Camera state data */ struct CameraData { /** Camera state data */
ScummVM::Point _cur; ScummVM::Point _cur;
ScummVM::Point _dest; ScummVM::Point _dest;
ScummVM::Point _accel; ScummVM::Point _accel;
@ -41,7 +41,7 @@ struct CameraData { /* Camera state data */
bool _movingToActor; bool _movingToActor;
}; };
struct VirtScreen { /* Virtual screen areas */ struct VirtScreen { /** Virtual screen areas */
int number; int number;
uint16 topline; uint16 topline;
uint16 width, height; uint16 width, height;
@ -55,7 +55,7 @@ struct VirtScreen { /* Virtual screen areas */
byte *backBuf; byte *backBuf;
}; };
struct ColorCycle { /* Palette cycles */ struct ColorCycle { /** Palette cycles */
uint16 delay; uint16 delay;
uint16 counter; uint16 counter;
uint16 flags; uint16 flags;
@ -63,7 +63,7 @@ struct ColorCycle { /* Palette cycles */
byte end; byte end;
}; };
struct BlastObject { /* BlastObjects to draw */ struct BlastObject { /** BlastObjects to draw */
uint16 number; uint16 number;
int16 posX, posY; int16 posX, posY;
uint16 width, height; uint16 width, height;
@ -72,7 +72,8 @@ struct BlastObject { /* BlastObjects to draw */
uint16 mode; uint16 mode;
}; };
struct BompDrawData { /* Bomp graphics data */ /** Bomp graphics data, used as parameter to Scumm::drawBomp. */
struct BompDrawData {
byte *out; byte *out;
int outwidth, outheight; int outwidth, outheight;
int x, y; int x, y;

5
scumm/object.cpp
View file

@ -207,8 +207,9 @@ int Scumm::getObjectOrActorXY(int object, int &x, int &y) {
return 0; return 0;
} }
/* Return the position of an object. /**
Returns X, Y and direction in angles * Return the position of an object.
* Returns X, Y and direction in angles
*/ */
void Scumm::getObjectXYPos(int object, int &x, int &y, int &dir) { void Scumm::getObjectXYPos(int object, int &x, int &y, int &dir) {
ObjectData *od = &_objs[getObjectIndex(object)]; ObjectData *od = &_objs[getObjectIndex(object)];

4
scumm/resource.cpp
View file

@ -152,7 +152,7 @@ void Scumm::closeRoom() {
} }
} }
/* Delete the currently loaded room offsets */ /** Delete the currently loaded room offsets. */
void Scumm::deleteRoomOffsets() { void Scumm::deleteRoomOffsets() {
if (!(_features & GF_SMALL_HEADER) && !_dynamicRoomOffsets) if (!(_features & GF_SMALL_HEADER) && !_dynamicRoomOffsets)
return; return;
@ -163,7 +163,7 @@ void Scumm::deleteRoomOffsets() {
} }
} }
/* Read room offsets */ /** Read room offsets */
void Scumm::readRoomsOffsets() { void Scumm::readRoomsOffsets() {
int num, room, i; int num, room, i;
byte *ptr; byte *ptr;

1
scumm/scumm.h
View file

@ -275,7 +275,6 @@ public:
ObjectData *_objs; ObjectData *_objs;
ScummDebugger *_debugger; ScummDebugger *_debugger;
Bundle *_bundle; Bundle *_bundle;
Timer *_timer;
Sound *_sound; Sound *_sound;
struct { struct {

2
scumm/scummvm.cpp
View file

@ -199,7 +199,6 @@ Scumm::Scumm (GameDetector *detector, OSystem *syst)
_objs = NULL; _objs = NULL;
_debugger = NULL; _debugger = NULL;
_bundle = NULL; _bundle = NULL;
_timer =NULL;
_sound= NULL; _sound= NULL;
memset(&res, 0, sizeof(res)); memset(&res, 0, sizeof(res));
memset(&vm, 0, sizeof(vm)); memset(&vm, 0, sizeof(vm));
@ -559,7 +558,6 @@ Scumm::Scumm (GameDetector *detector, OSystem *syst)
_newgui = g_gui; _newgui = g_gui;
_bundle = new Bundle(); _bundle = new Bundle();
_sound = new Sound(this); _sound = new Sound(this);
_timer = Engine::_timer;
_sound->_sound_volume_master = detector->_master_volume; _sound->_sound_volume_master = detector->_master_volume;
_sound->_sound_volume_sfx = detector->_sfx_volume; _sound->_sound_volume_sfx = detector->_sfx_volume;