(no commit message)

[grpapi.git] / grpapi / grpapi.h

/*\r
\r
  ShadowFlare GRP Library. (c) ShadowFlare Software 2002-2006\r
\r
  Any comments or suggestions are accepted at blakflare@hotmail.com (ShadowFlare)\r
*/\r
\r
#ifndef GRPAPI_INCLUDED\r
#define GRPAPI_INCLUDED\r
\r
#include <windows.h>\r
\r
#ifndef GRPAPI_STATIC\r
\r
#ifdef GRPAPI_EXPORTS\r
#define GRPAPI __declspec(dllexport)\r
#else\r
#define GRPAPI __declspec(dllimport)\r
#endif\r
\r
#else\r
#define GRPAPI\r
#endif\r
\r
#ifdef __cplusplus\r
extern "C" {\r
#endif\r
\r
typedef struct {\r
	WORD nFrames;\r
	WORD wMaxWidth;\r
	WORD wMaxHeight;\r
} GRPHEADER;\r
\r
#define HORIZONTAL_FLIP 0x00000001 // Flips the graphic horizontally\r
#define VERTICAL_FLIP   0x00000002 // Flips the graphic vertically\r
#define SHADOW_COLOR    0x00000004 // Causes the graphic to be drawn in one color\r
                                   // Second byte of flags is the red component of\r
                                   // the shadow's color, third byte is green,\r
                                   // fourth byte is blue; like this:\r
                                   // SHADOW_COLOR|0xBBGGRR00\r
                                   // This can be accomplished by using the left shift\r
                                   // operator like this:  SHADOW_COLOR|(color << 8)\r
#define ALPHA_BLEND     0x00000008 // Blends the graphic with what it is being drawn over.\r
                                   // The dwAlpha parameter will only be used when this\r
                                   // flag is specified.  dwAlpha is an RGB value\r
                                   // (0xBBGGRR).\r
                                   // Note: Because of the extra calculations required,\r
                                   // alpha blended graphics take longer to draw\r
#define USE_INDEX       0x00000010 // Only valid when used with a custom SetPixel function.\r
                                   // This flag cannot be used in combination with\r
                                   // ALPHA_BLEND or SHADOW_COLOR\r
                                   // When this flag is used, the index to a color in the\r
                                   // palette will be passed to your custom SetPixel\r
                                   // function instead of the actual color.\r
\r
// Palette is an array of 256 DWORD's\r
// For LoadPalette and LoadGrp, lpFileName may be a file in an open mpq archive\r
// or a file not in an archive\r
BOOL   GRPAPI WINAPI LoadPalette(LPCSTR lpFileName, DWORD *dwPaletteBuffer);\r
HANDLE GRPAPI WINAPI LoadGrp(LPCSTR lpFileName);\r
BOOL   GRPAPI WINAPI DestroyGrp(HANDLE hGrp);\r
BOOL   GRPAPI WINAPI DrawGrp(HANDLE hGrp, HDC hdcDest, int nXDest, int nYDest, WORD nFrame, DWORD *dwPalette, DWORD dwFlags, DWORD dwAlpha);\r
BOOL   GRPAPI WINAPI GetGrpInfo(HANDLE hGrp, GRPHEADER *GrpInfo);\r
BOOL   GRPAPI WINAPI GetGrpFrameInfo(HANDLE hGrp, WORD nFrame, DWORD *nLeft, DWORD *nTop, DWORD *nWidth, DWORD *nHeight);\r
\r
// A pointer to the raw image data to encode should be passed to lpImageData.  The size of\r
// the buffer containing the data should be nFrames * wMaxWidth * wMaxHeight * sizeof(short)\r
// and the values should be arranged row by row of the frame, with the top row first.\r
// After all the rows of a frame have been put into the buffer, the rows of the next frame\r
// go after it.  For transparent pixels, they should be set to -1.  All other pixels should\r
// have the high order byte set to zero, meaning that they should not be negative and the\r
// values should not exceed 255 (0xFF).  The values used for the colors are indexes into the\r
// color palette.\r
// Pass TRUE to bNoCompress if you need an uncompressed GRP.\r
// Pass a pointer to a DWORD value to nGrpSize to receive the size in bytes of the resulting encoded GRP.\r
// The return value of this function is actually a pointer to the GRP data.  This is what your\r
// program should save to a file.  The size of this buffer is the value received by nGrpSize.\r
// When your program is done with the returned buffer, it should call DestroyGrp on the\r
// buffer that was returned by this function to free up the memory from it.\r
// The pointer returned by this function can also be directly used by DrawGrp or GetGrpInfo.\r
HANDLE GRPAPI WINAPI CreateGrp(signed short *lpImageData, WORD nFrames, WORD wMaxWidth, WORD wMaxHeight, BOOL bNoCompress, DWORD *nGrpSize);\r
\r
typedef COLORREF (WINAPI* GETPIXELPROC)(\r
  HDC hDC, // same value as hdcDest from DrawGrp,\r
	       // does not need to be used as an HDC,\r
	       // can be used for any other type of pointer\r
  int X,   // x-coordinate of pixel\r
  int Y    // y-coordinate of pixel\r
);\r
typedef void (WINAPI* SETPIXELPROC)(\r
	HDC hDC,          // same value as hdcDest from DrawGrp,\r
	                  // does not need to be used as an HDC,\r
	                  // can be used for any other type of pointer\r
	int X,            // x-coordinate of pixel\r
	int Y,            // y-coordinate of pixel\r
	COLORREF clrColor // new pixel color\r
);\r
\r
// Call these to have DrawGrp use custom functions for reading and drawing pixels\r
// so that you can have it read from and write to a buffer, for example.\r
void GRPAPI WINAPI SetFunctionGetPixel(GETPIXELPROC lpGetPixelProc); // Only used with ALPHA_BLEND\r
void GRPAPI WINAPI SetFunctionSetPixel(SETPIXELPROC lpSetPixelProc);\r
\r
// Call this to make a different Storm.dll-compatible MPQ library be used (like SFMPQ).\r
BOOL GRPAPI WINAPI SetMpqDll(LPCSTR lpDllFileName);\r
\r
// These no longer need to be called\r
BOOL   GRPAPI WINAPI LoadGrpApi();\r
void   GRPAPI WINAPI FreeGrpApi();\r
\r
#ifdef __cplusplus\r
};  // extern "C" \r
#endif\r
\r
#endif\r