FIFE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
glimage.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2013 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef FIFE_VIDEO_RENDERBACKENDS_OPENGL_GLIMAGE_H
23 #define FIFE_VIDEO_RENDERBACKENDS_OPENGL_GLIMAGE_H
24 
25 // Standard C++ library includes
26 #include <vector>
27 
28 // Platform specific includes
29 #include "util/base/fife_stdint.h"
30 
31 // 3rd party library includes
32 #include <SDL_video.h>
33 
34 // FIFE includes
35 // These includes are split up in two parts, separated by one empty line
36 // First block: files included from the FIFE root src directory
37 // Second block: files included from the same folder
38 #include "video/image.h"
39 
40 #include "fife_opengl.h"
41 
42 namespace FIFE {
43 
53  class GLImage : public Image {
54  public:
55  GLImage(IResourceLoader* loader = 0);
56  GLImage(const std::string& name, IResourceLoader* loader = 0);
57  GLImage(SDL_Surface* surface);
58  GLImage(const std::string& name, SDL_Surface* surface);
59  GLImage(const uint8_t* data, uint32_t width, uint32_t height);
60  GLImage(const std::string& name, const uint8_t* data, uint32_t width, uint32_t height);
61 
62  virtual ~GLImage();
63  virtual void invalidate();
64  virtual void setSurface(SDL_Surface* surface);
65  virtual void render(const Rect& rect, uint8_t alpha = 255, uint8_t const* rgb = 0);
66  virtual void useSharedImage(const ImagePtr& shared, const Rect& region);
67  virtual void forceLoadInternal();
68  virtual void copySubimage(uint32_t xoffset, uint32_t yoffset, const ImagePtr& img);
69  virtual void load();
70  virtual void free();
71 
72  GLuint getTexId() const;
73  const GLfloat* getTexCoords() const;
74  bool isCompressed() const { return m_compressed; }
75  void setCompressed(bool compressed) { m_compressed = compressed; }
76  private:
77  // texture coords to use
78  GLfloat m_tex_coords[4];
79 
80  // Was this image compressed by OpenGL driver during loading ?
82 
83  // [0] [2] ->(x)
84  // [1] +------+
85  // | |
86  // | |
87  // [3] +------+
88  //
89  // |
90  // v
91  // (y)
92  // To map these indices with previous one:
93  // [0]:=[1]:=0.0f, [2]:=m_col_tex_coords, [3]:=m_row_tex_coords
94 
95 
98  GLuint m_texId;
99 
102  void cleanup();
103 
106  void resetGlimage();
107 
110  void generateGLTexture();
111  void generateGLSharedTexture(const GLImage* shared, const Rect& region);
112  void validateShared();
113 
116 
117  SDL_Color m_colorkey;
118 
120  // Holds Atlas ImagePtr if this is a shared image
122  // Holds Atlas Name if this is a shared image
123  std::string m_atlas_name;
124  };
125 
126 }
127 
128 #endif
129 /* vim: set noexpandtab: set shiftwidth=2: set tabstop=2: */
virtual void invalidate()
Invalidates the Image causing it to be reset or re-loaded.
Definition: glimage.cpp:94
void generateGLTexture()
Generates the GL Texture for use when rendering.
Definition: glimage.cpp:149
virtual void load()
Definition: glimage.cpp:386
uint32_t m_chunk_size_w
Definition: glimage.h:114
Base Class for Images.
Definition: image.h:47
GLfloat m_tex_coords[4]
Definition: glimage.h:78
virtual void setSurface(SDL_Surface *surface)
This frees the current suface and replaces it with the surface passed in the parameter (which can be ...
Definition: glimage.cpp:98
void setCompressed(bool compressed)
Definition: glimage.h:75
void resetGlimage()
Resets GLImage variables.
Definition: glimage.cpp:103
GLImage(IResourceLoader *loader=0)
Definition: glimage.cpp:40
GLuint getTexId() const
Definition: glimage.cpp:417
std::string m_atlas_name
Definition: glimage.h:123
const GLfloat * getTexCoords() const
Definition: glimage.cpp:421
virtual void copySubimage(uint32_t xoffset, uint32_t yoffset, const ImagePtr &img)
Copies given image into this one with respect to given offsets.
Definition: glimage.cpp:376
virtual void useSharedImage(const ImagePtr &shared, const Rect &region)
After this call all image data will be taken from the given image and its subregion.
Definition: glimage.cpp:332
SDL_Color m_colorkey
Definition: glimage.h:117
unsigned char uint8_t
Definition: core.h:38
GLuint m_texId
Holds texture ids that are used to access textures in GL rendering context.
Definition: glimage.h:98
virtual ~GLImage()
Definition: glimage.cpp:90
void generateGLSharedTexture(const GLImage *shared, const Rect &region)
Definition: glimage.cpp:317
bool isCompressed() const
Definition: glimage.h:74
GLImage * m_shared_img
Definition: glimage.h:119
virtual void forceLoadInternal()
Forces to load the image into internal memory of GPU.
Definition: glimage.cpp:351
void cleanup()
Frees allocated memory and calls resetGlImage.
Definition: glimage.cpp:112
bool m_compressed
Definition: glimage.h:81
uint32_t m_chunk_size_h
Definition: glimage.h:115
virtual void free()
Definition: glimage.cpp:412
Implements an Image using OpenGL.
Definition: glimage.h:53
virtual void render(const Rect &rect, uint8_t alpha=255, uint8_t const *rgb=0)
Renders itself to the current render target (main screen or attached destination image) at the rectan...
Definition: glimage.cpp:125
unsigned int uint32_t
Definition: core.h:40
ImagePtr m_atlas_img
Definition: glimage.h:121
void validateShared()
Definition: glimage.cpp:359