graphics/thumbnail.h

   1 /* ScummVM - Graphic Adventure Engine
   2  *
   3  * ScummVM is the legal property of its developers, whose names
   4  * are too numerous to list here. Please refer to the COPYRIGHT
   5  * file distributed with this source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  *
  21  * $URL$
  22  * $Id$
  23  */
  24
  25 #ifndef GRAPHICS_THUMBNAIL_H
  26 #define GRAPHICS_THUMBNAIL_H
  27
  28 #include "common/stream.h"
  29 #include "graphics/surface.h"
  30
  31 namespace Graphics {
  32
  33 /**
  34  * Checks for presence of the thumbnail save header.
  35  * Seeks automatically back to start position after check.
  36  *
  37  * @param in    stream to check for header
  38  */
  39 bool checkThumbnailHeader(Common::SeekableReadStream &in);
  40
  41 /**
  42  * Skips a thumbnail header, if present.
  43  *
  44  * @param in    stream to process
  45  */
  46 bool skipThumbnailHeader(Common::SeekableReadStream &in);
  47
  48 /**
  49  * Lodas a thumbnail from the given input stream.
  50  * The loaded thumbnail will be automatically converted to the
  51  * current overlay pixelformat.
  52  */
  53 bool loadThumbnail(Common::SeekableReadStream &in, Graphics::Surface &to);
  54
  55 /**
  56  * Saves a thumbnail to the given write stream.
  57  * Automatically creates a thumbnail from screen contents.
  58  */
  59 bool saveThumbnail(Common::WriteStream &out);
  60
  61 /**
  62  * Saves a (given) thumbnail to the given write stream.
  63  */
  64 bool saveThumbnail(Common::WriteStream &out, const Graphics::Surface &thumb);
  65
  66 } // end of namespace Graphics
  67
  68 #endif
  69