scummvm/engines/draci/surface.cpp
Denis Kasak f5e39fa61d * Expanded docs for the Sprite class
* Added Surface and Screen docs
* Small documentation fixes

svn-id: r41779
2009-06-22 20:13:25 +00:00

121 lines
2.5 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
#include "draci/screen.h"
#include "draci/surface.h"
namespace Draci {
Surface::Surface(int width, int height) {
this->create(width, height, 1);
this->markClean();
_transparentColour = kDefaultTransparent;
}
Surface::~Surface() {
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;
r.clip(w, h);
if (r.isEmpty())
return;
it = _dirtyRects.begin();
while (it != _dirtyRects.end()) {
if (it->contains(r))
return;
if (r.contains(*it))
it = _dirtyRects.erase(it);
else
++it;
}
_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;
}
} // End of namespace Draci