Mercurial > fife-parpg

comparison ext/guichan-0.8.2/include/guichan/opengl/openglimage.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_OPENGLIMAGE_HPP
45 #define GCN_OPENGLIMAGE_HPP
46
47 #if defined (_WIN32)
48 #define WIN32_LEAN_AND_MEAN
49 #include <windows.h>
50 #endif
51
52 #if defined (__amigaos4__)
53 #include <mgl/gl.h>
54 #elif defined (__APPLE__)
55 #include <OpenGL/gl.h>
56 #else
57 #include <GL/gl.h>
58 #endif
59
60 #include <string>
61
62 #include "guichan/color.hpp"
63 #include "guichan/platform.hpp"
64 #include "guichan/image.hpp"
65
66 namespace gcn
67 {
68 /**
69 * OpenGL implementation of Image.
70 */
71 class GCN_EXTENSION_DECLSPEC OpenGLImage : public Image
72 {
73 public:
74 /**
75 * Constructor. Loads an image from an array of pixels. The pixel array is
76 * is copied in the constructor and should thus be freed after the constructor
77 * has been called.
78 *
79 * NOTE: The functions getPixel and putPixel are only guaranteed to work
80 * before an image has been converted to display format.
81 *
82 * @param pixels to load from.
83 * @param width the width of the image.
84 * @param height the height of the image.
85 * @param convertToDisplayFormat true if the image should be converted
86 * to display, false otherwise.
87 */
88 OpenGLImage(const unsigned int* pixels, int width, int height, bool convertToDisplayFormat = true);
89
90 /**
91 * Constructor. Load an image from an OpenGL texture handle. The width
92 * and height specifies the size of the "interesting" part of the
93 * texture, the real width and height of the texture are assumed to
94 * be the closest higher power of two.
95 *
96 * @param textureHandle the texture handle from which to load.
97 * @param width the width of the image.
98 * @param height the height of the image.
99 * @param autoFree true if the surface should automatically be deleted.
100 */
101 OpenGLImage(GLuint textureHandle, int width, int height, bool autoFree);
102
103 /**
104 * Destructor.
105 */
106 virtual ~OpenGLImage();
107
108 /**
109 * Gets the OpenGL texture handle for the image.
110 *
111 * @return the OpenGL texture handle for the image.
112 */
113
114 virtual GLuint getTextureHandle() const;
115
116 /**
117 * Gets the width of texture.
118 *
119 * @return the width of the texture.
120 */
121 virtual int getTextureWidth() const;
122
123 /**
124 * Gets the height of the texture.
125 *
126 * @return the height of the texture.
127 */
128 virtual int getTextureHeight() const;
129
130
131 // Inherited from Image
132
133 virtual void free();
134
135 virtual int getWidth() const;
136
137 virtual int getHeight() const;
138
139 virtual Color getPixel(int x, int y);
140
141 virtual void putPixel(int x, int y, const Color& color);
142
143 virtual void convertToDisplayFormat();
144
145 protected:
146 GLuint mTextureHandle;
147 unsigned int* mPixels;
148 bool mAutoFree;
149 int mWidth;
150 int mHeight;
151 int mTextureWidth;
152 int mTextureHeight;
153
154 };
155 }
156
157 #endif // end GCN_OPENGLIMAGE_HPP