blender/source/gameengine/GamePlayer/common/GPC_RawImage.h
2002-12-27 13:11:01 +00:00

123 lines
3.3 KiB
C++

/**
* $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__