[Scummvm-cvs-logs] SF.net SVN: scummvm:[41779] scummvm/branches/gsoc2009-draci/engines/draci
dkasak13 at users.sourceforge.net
dkasak13 at users.sourceforge.net
Mon Jun 22 22:13:25 CEST 2009
Revision: 41779
http://scummvm.svn.sourceforge.net/scummvm/?rev=41779&view=rev
Author: dkasak13
Date: 2009-06-22 20:13:25 +0000 (Mon, 22 Jun 2009)
Log Message:
-----------
* Expanded docs for the Sprite class
* Added Surface and Screen docs
* Small documentation fixes
Modified Paths:
--------------
scummvm/branches/gsoc2009-draci/engines/draci/font.h
scummvm/branches/gsoc2009-draci/engines/draci/screen.cpp
scummvm/branches/gsoc2009-draci/engines/draci/sprite.cpp
scummvm/branches/gsoc2009-draci/engines/draci/sprite.h
scummvm/branches/gsoc2009-draci/engines/draci/surface.cpp
scummvm/branches/gsoc2009-draci/engines/draci/surface.h
Modified: scummvm/branches/gsoc2009-draci/engines/draci/font.h
===================================================================
--- scummvm/branches/gsoc2009-draci/engines/draci/font.h 2009-06-22 19:56:06 UTC (rev 41778)
+++ scummvm/branches/gsoc2009-draci/engines/draci/font.h 2009-06-22 20:13:25 UTC (rev 41779)
@@ -37,7 +37,7 @@
* Default font colours. They all seem to remain constant except for the
* first one which varies depending on the character speaking.
* kOverFontColour is set to transparent.
- * TODO: Find out what kFontColour1 should actually be when the game starts
+ * TODO: Find out what kFontColour1 should actually be when the game starts
*/
enum {
kFontColour1 = 2, kFontColour2 = 0,
Modified: scummvm/branches/gsoc2009-draci/engines/draci/screen.cpp
===================================================================
--- scummvm/branches/gsoc2009-draci/engines/draci/screen.cpp 2009-06-22 19:56:06 UTC (rev 41778)
+++ scummvm/branches/gsoc2009-draci/engines/draci/screen.cpp 2009-06-22 20:13:25 UTC (rev 41779)
@@ -42,6 +42,10 @@
delete[] _palette;
}
+/**
+ * @brief Sets the first numEntries of palette to zero
+ * @param numEntries The number of entries to set to zero (from start)
+ */
void Screen::setPaletteEmpty(unsigned int numEntries) {
for (unsigned int i = 0; i < 4 * numEntries; ++i) {
_palette[i] = 0;
@@ -51,6 +55,12 @@
copyToScreen();
}
+/**
+ * @brief Sets a part of the palette
+ * @param data Pointer to a buffer containing new palette data
+ * start Index of the colour where replacement should start
+ * num Number of colours to replace
+ */
void Screen::setPalette(byte *data, uint16 start, uint16 num) {
Common::MemoryReadStream pal(data, 3 * kNumColours);
@@ -65,7 +75,7 @@
}
// TODO: Investigate why this is needed
- // Shift the palette one bit to the left to make it brighter
+ // Shift the palette two bits to the left to make it brighter
for (unsigned int i = 0; i < 4 * kNumColours; ++i) {
_palette[i] <<= 2;
}
@@ -74,17 +84,26 @@
copyToScreen();
}
+/**
+ * @brief Copies the current memory screen buffer to the real screen
+ */
void Screen::copyToScreen() const {
Common::List<Common::Rect> *dirtyRects = _surface->getDirtyRects();
Common::List<Common::Rect>::iterator it;
+ // If a full update is needed, update the whole screen
if (_surface->needsFullUpdate()) {
byte *ptr = (byte *)_surface->getBasePtr(0, 0);
_vm->_system->copyRectToScreen(ptr, kScreenWidth,
0, 0, kScreenWidth, kScreenHeight);
} else {
+
+ // Otherwise, update only the dirty rectangles
+
for (it = dirtyRects->begin(); it != dirtyRects->end(); ++it) {
+
+ // Pointer to the upper left corner of the rectangle
byte *ptr = (byte *)_surface->getBasePtr(it->left, it->top);
_vm->_system->copyRectToScreen(ptr, kScreenWidth,
@@ -92,11 +111,16 @@
}
}
+ // Call the "real" updateScreen and mark the surface clean
_vm->_system->updateScreen();
_surface->markClean();
}
-
+/**
+ * @brief Clears the screen
+ *
+ * Clears the screen and marks the whole screen dirty.
+ */
void Screen::clearScreen() const {
byte *ptr = (byte *)_surface->getBasePtr(0, 0);
@@ -105,6 +129,12 @@
memset(ptr, 0, kScreenWidth * kScreenHeight);
}
+/**
+ * @brief Fills the screen with the specified colour
+ * @param colour The colour the screen should be filled with
+ *
+ * Fills the screen with the specified colour and marks the whole screen dirty.
+ */
void Screen::fillScreen(uint16 colour) const {
byte *ptr = (byte *)_surface->getBasePtr(0, 0);
@@ -113,10 +143,17 @@
memset(ptr, colour, kScreenWidth * kScreenHeight);
}
+/**
+ * @brief Draws a rectangle on the screen
+ * @param r Which rectangle to draw
+ * colour The colour of the rectangle
+ */
void Screen::drawRect(Common::Rect &r, uint8 colour) {
+ // Clip the rectangle to screen size
r.clip(_surface->w, _surface->h);
+ // If the whole rectangle is outside the screen, return
if (r.isEmpty())
return;
@@ -131,10 +168,18 @@
_surface->markDirtyRect(r);
}
+/**
+ * @brief Fetches the current palette
+ * @return A byte pointer to the current palette
+ */
byte *Screen::getPalette() const {
return _palette;
}
+/**
+ * @brief Fetches the current surface
+ * @return A pointer to the current surface
+ */
Draci::Surface *Screen::getSurface() {
return _surface;
}
Modified: scummvm/branches/gsoc2009-draci/engines/draci/sprite.cpp
===================================================================
--- scummvm/branches/gsoc2009-draci/engines/draci/sprite.cpp 2009-06-22 19:56:06 UTC (rev 41778)
+++ scummvm/branches/gsoc2009-draci/engines/draci/sprite.cpp 2009-06-22 20:13:25 UTC (rev 41779)
@@ -37,7 +37,10 @@
bool columnwise) : _width(width), _height(height), _x(x), _y(y), _data(NULL) {
_data = new byte[width * height];
-
+
+ // If the sprite is stored row-wise, just copy it to the internal buffer.
+ // Otherwise, transform it and then copy.
+
if (!columnwise) {
memcpy(_data, raw_data, width * height);
} else {
@@ -62,7 +65,10 @@
_height = reader.readUint16LE();
_data = new byte[_width * _height];
-
+
+ // If the sprite is stored row-wise, just copy it to the internal buffer.
+ // Otherwise, transform it and then copy.
+
if (!columnwise) {
reader.read(_data, _width * _height);
} else {
@@ -78,12 +84,21 @@
delete[] _data;
}
+/**
+ * @brief Draws the sprite to a Draci::Surface
+ * @param surface Pointer to a Draci::Surface
+ *
+ * Draws the sprite to a Draci::Surface and marks its rectangle on the surface as dirty.
+ */
void Sprite::draw(Surface *surface) const {
byte *dst = (byte *)surface->getBasePtr(_x, _y);
byte *src = _data;
+ // Blit the sprite to the surface
for (unsigned int i = 0; i < _height; ++i) {
for(unsigned int j = 0; j < _width; ++j, ++src) {
+
+ // Don't blit if the pixel is transparent on the target surface
if (*src != surface->getTransparentColour())
dst[j] = *src;
}
@@ -91,6 +106,7 @@
dst += surface->pitch;
}
+ // Mark the sprite's rectangle dirty
Common::Rect r(_x, _y, _x + _width, _y + _height);
surface->markDirtyRect(r);
}
Modified: scummvm/branches/gsoc2009-draci/engines/draci/sprite.h
===================================================================
--- scummvm/branches/gsoc2009-draci/engines/draci/sprite.h 2009-06-22 19:56:06 UTC (rev 41778)
+++ scummvm/branches/gsoc2009-draci/engines/draci/sprite.h 2009-06-22 20:13:25 UTC (rev 41779)
@@ -56,10 +56,10 @@
void draw(Surface *surface) const;
- byte *_data;
- uint16 _width;
- uint16 _height;
- uint16 _x, _y;
+ byte *_data; //!< Pointer to a buffer containing raw sprite data (row-wise)
+ uint16 _width; //!< Width of the sprite
+ uint16 _height; //!< Height of the sprite
+ uint16 _x, _y; //!< Sprite coordinates
};
Modified: scummvm/branches/gsoc2009-draci/engines/draci/surface.cpp
===================================================================
--- scummvm/branches/gsoc2009-draci/engines/draci/surface.cpp 2009-06-22 19:56:06 UTC (rev 41778)
+++ scummvm/branches/gsoc2009-draci/engines/draci/surface.cpp 2009-06-22 20:13:25 UTC (rev 41779)
@@ -38,6 +38,10 @@
this->free();
}
+/**
+ * @brief Marks a dirty rectangle on the surface
+ * @param r The rectangle to be marked dirty
+ */
void Surface::markDirtyRect(Common::Rect r) {
Common::List<Common::Rect>::iterator it;
@@ -61,31 +65,54 @@
_dirtyRects.push_back(r);
}
+/**
+ * @brief Clears all dirty rectangles
+ *
+ */
void Surface::clearDirtyRects() {
_dirtyRects.clear();
}
+/**
+ * @brief Marks the whole surface dirty
+ */
void Surface::markDirty() {
_fullUpdate = true;
}
+/**
+ * @brief Marks the whole surface clean
+ */
void Surface::markClean() {
_fullUpdate = false;
_dirtyRects.clear();
}
+/**
+ * @brief Checks whether the surface needs a full update
+ */
bool Surface::needsFullUpdate() {
return _fullUpdate;
}
+/**
+ * @brief Fetches the surface's dirty rectangles
+ * @return A pointer a list of dirty rectangles
+ */
Common::List<Common::Rect> *Surface::getDirtyRects() {
return &_dirtyRects;
}
+/**
+ * @brief Returns the current transparent colour of the surface
+ */
uint8 Surface::getTransparentColour() {
return _transparentColour;
}
+/**
+ * @brief Sets the surface's transparent colour
+ */
void Surface::setTransparentColour(uint8 colour) {
_transparentColour = colour;
}
Modified: scummvm/branches/gsoc2009-draci/engines/draci/surface.h
===================================================================
--- scummvm/branches/gsoc2009-draci/engines/draci/surface.h 2009-06-22 19:56:06 UTC (rev 41778)
+++ scummvm/branches/gsoc2009-draci/engines/draci/surface.h 2009-06-22 20:13:25 UTC (rev 41779)
@@ -46,9 +46,18 @@
void setTransparentColour(uint8 colour);
private:
- bool _fullUpdate;
+ /** The current transparent colour of the surface. See getTransparentColour() and
+ * setTransparentColour().
+ */
uint8 _transparentColour;
- Common::List<Common::Rect> _dirtyRects;
+
+ /** Set when the surface is scheduled for a full update.
+ * See markDirty(), markClean(). Accessed via needsFullUpdate().
+ */
+ bool _fullUpdate;
+
+ Common::List<Common::Rect> _dirtyRects; //!< List of currently dirty rectangles
+
};
} // End of namespace Draci
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Scummvm-git-logs
mailing list