Mercurial > fife-parpg

comparison ext/guichan-0.8.2/include/guichan/imageloader.hpp @ 378:64738befdf3b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bringing in the changes from the build_system_rework branch in preparation for the 0.3.0 release. This commit will require the Jan2010 devkit. Clients will also need to be modified to the new way to import fife.
author vtchill@33b003aa-7bff-0310-803a-e67f0ece8222
date Mon, 11 Jan 2010 23:34:52 +0000
parents
children
comparison
equal deleted inserted replaced
377:fe6fb0e0ed23 378:64738befdf3b
1 /* _______ __ __ __ ______ __ __ _______ __ __
2 * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3 * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4 * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5 * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8 *
9 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
10 *
11 *
12 * Per Larsson a.k.a finalman
13 * Olof Naessén a.k.a jansem/yakslem
14 *
15 * Visit: http://guichan.sourceforge.net
16 *
17 * License: (BSD)
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
26 * distribution.
27 * 3. Neither the name of Guichan nor the names of its contributors may
28 * be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
37 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
38 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
40 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 #ifndef GCN_IMAGELOADER_HPP
45 #define GCN_IMAGELOADER_HPP
46
47 #include <string>
48
49 #include "guichan/platform.hpp"
50
51 namespace gcn
52 {
53 class Image;
54
55 /**
56 * Abstract class for providing functions for loading images.
57 *
58 * Guichan contains implementations of ImageLoader for common
59 * libraries like the Allegro library, the HGE library,
60 * he OpenLayer library, and the SDL library.
61 * To make Guichan usable with other libraries, an ImageLoader
62 * class must be implemented.
63 *
64 * To make Guichan use an image loader, the image loader needs
65 * to be passed to the Image class using the static method
66 * Image::setImageLoader.
67 *
68 * @see Image::setImageLoader, Image::getImageLoader,
69 * AllegroImageLoader, HGEImageLoader, OpenLayerImageLoader,
70 * OpenGLAllegroImageLoader, OpenGLSDLImageLoader,
71 * SDLImageLoader
72 * @since 0.1.0
73 */
74 class GCN_CORE_DECLSPEC ImageLoader
75 {
76 public:
77
78 /**
79 * Destructor.
80 */
81 virtual ~ImageLoader() { }
82
83 /**
84 * Loads an image.
85 *
86 * NOTE: The functions Image::getPixel and Image::putPixel
87 * are only guaranteed to work before an image has
88 * been converted to display format.
89 *
90 * @param filename The filename of the image to load.
91 * @param convertToDisplayFormat True if the image should be converted
92 * to display, false otherwise.
93 */
94 virtual Image* load(const std::string& filename, bool convertToDisplayFormat = true) = 0;
95 };
96 }
97
98 #endif // end GCN_IMAGELOADER_HPP