diff options
author | Hans Lambermont <hans@lambermont.dyndns.org> | 2002-10-12 15:37:38 +0400 |
---|---|---|
committer | Hans Lambermont <hans@lambermont.dyndns.org> | 2002-10-12 15:37:38 +0400 |
commit | 12315f4d0e0ae993805f141f64cb8c73c5297311 (patch) | |
tree | 59b45827cd8293cfb727758989c7a74b40183974 /source/gameengine/GamePlayer/common/GPC_RawImage.h |
Initial revisionv2.25
Diffstat (limited to 'source/gameengine/GamePlayer/common/GPC_RawImage.h')
-rw-r--r-- | source/gameengine/GamePlayer/common/GPC_RawImage.h | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/source/gameengine/GamePlayer/common/GPC_RawImage.h b/source/gameengine/GamePlayer/common/GPC_RawImage.h new file mode 100644 index 00000000000..ac9dad77d2f --- /dev/null +++ b/source/gameengine/GamePlayer/common/GPC_RawImage.h @@ -0,0 +1,122 @@ +/** + * $Id$ + * + * ***** BEGIN GPL/BL DUAL LICENSE BLOCK ***** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. The Blender + * Foundation also sells licenses for use in proprietary software under + * the Blender License. See http://www.blender.org/BL/ for information + * about this. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * + * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV. + * All rights reserved. + * + * The Original Code is: all of this file. + * + * Contributor(s): none yet. + * + * ***** END GPL/BL DUAL LICENSE BLOCK ***** + */ + +#ifndef __GPC_RAWIMAGE_H__ +#define __GPC_RAWIMAGE_H__ + +/** + * This memory resource reads images from the application resources. + * Images are expected to be stored as raw RGBA bytes. + * You can generate these images by exporting images with an alpha + * channel from Photoshop in RAW format with interleaved channels. + */ + +class GPC_RawImage +{ +public: + GPC_RawImage(); + + typedef enum { + alignTopLeft, + alignBottomRight + } TImageAlignment; + + /** + * Loads the image form the resource into memory. + * Converts size of the image and places it with given alignment. + * @param hInstApp The application's instance (location of the resources). + * @param lpName Name of the resource. + * @param lpType Type of the resource. + * @param srcWidth The width of the resource image. + * @param srcHeight The height of the resource image. + * @param width The width of the image created. + * @param height The height of the image created. + * @param alignment How the resource image is located in the image created. + * @param offsetX Amount of horzontal offset applied to the resource image. + * @param offsetY Amount of vertical offset applied to the resource image. + */ + virtual bool Load(char *srcName, + int destWidth, int destHeight, + TImageAlignment alignment = alignTopLeft, + int offsetX = 0, int offsetY = 0); + + /** + * Returns the width of the image. + * @return The width of the image. + */ + virtual int Width() const + { + return m_width; + } + + /** + * Returns the height of the image. + * @return The height of the image. + */ + virtual int Height() const + { + return m_height; + } + + /** + * Returns a pointer to the data loaded from the resource. + * @return A pointer to the data loaded from the resource. + */ + virtual unsigned char *Data() const + { + return m_data; + } + + /** + * Returns the size of the data loaded from the resource. + * @return The size of the loaded from the resource. + */ + virtual int DataSize() const + { + return m_dataSize; + } + +protected: + /** + * Disposes the data stored at the m_data member. + */ +// virtual void disposeData(void); + +protected: + unsigned char *m_data; + int m_dataSize; + int m_width; + int m_height; +}; + + +#endif // __GPC_RAWIMAGE_H__ |