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

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_HGEIMAGE_HPP
45 #define GCN_HGEIMAGE_HPP
46
47 #include <hge.h>
48 #include <hgesprite.h>
49 #include <string>
50
51 #include "guichan/color.hpp"
52 #include "guichan/platform.hpp"
53 #include "guichan/image.hpp"
54
55 namespace gcn
56 {
57 /**
58 * HGE implementation of Image.
59 *
60 * @author Kevin Lynx
61 * @since 0.6.1
62 */
63 class GCN_EXTENSION_DECLSPEC HGEImage : public Image
64 {
65 public:
66 /**
67 * Constructor.
68 *
69 * Creates an image from a HGE texture.
70 *
71 * NOTE : The functions getPixel and putPixel are only guaranteed to work
72 * with a 32bits image.
73 *
74 * @param sprite A HGE texture to create the image from.
75 * @param autoFree True it the image should be automatically deleted by
76 * the destructor, false otherwise.
77 */
78 HGEImage(HTEXTURE texture, bool autoFree = false);
79
80 /**
81 * Destructor.
82 *
83 */
84 ~HGEImage();
85
86 /**
87 * Gets the HGE sprite of the image.
88 *
89 * @return the HGE sprite of the image.
90 */
91 virtual hgeSprite *getSprite() const;
92
93
94 // Inherited from Image
95
96 virtual void free();
97
98 virtual int getWidth() const;
99
100 virtual int getHeight() const;
101
102 virtual Color getPixel(int x, int y);
103
104 virtual void putPixel(int x, int y, const Color &color);
105
106 virtual void convertToDisplayFormat();
107
108 protected:
109 static HGE *mHGE;
110 bool mAutoFree;
111 hgeSprite *mHGESprite;
112 HTEXTURE mTexture;
113 };
114 }
115
116 #endif // end GCN_HGEIMAGE_HPP