X-Git-Url: https://sfsrealm.hopto.org/projects/?a=blobdiff_plain;f=grpapi%2Fgrpapi.h;h=ca5262c3af4414fb52af6030345ce1035a8a46f5;hb=4d7b76a0306a5577bc7b2dd3264e75ea419f6942;hp=2f48cef5fe531129d1a228cd7f18bf19664bd661;hpb=ecca31ff6c588a09592e9a0ca08180828ab8a5a7;p=grpapi.git

diff --git a/grpapi/grpapi.h b/grpapi/grpapi.h
index 2f48cef..ca5262c 100644
--- a/grpapi/grpapi.h
+++ b/grpapi/grpapi.h
@@ -39,12 +39,20 @@ typedef struct {
                                    // the shadow's color, third byte is green,
                                    // fourth byte is blue; like this:
                                    // SHADOW_COLOR|0xBBGGRR00
+                                   // This can be accomplished by using the left shift
+                                   // operator like this:  SHADOW_COLOR|(color << 8)
 #define ALPHA_BLEND     0x00000008 // Blends the graphic with what it is being drawn over.
                                    // The dwAlpha parameter will only be used when this
                                    // flag is specified.  dwAlpha is an RGB value
                                    // (0xBBGGRR).
                                    // Note: Because of the extra calculations required,
                                    // alpha blended graphics take longer to draw
+#define USE_INDEX       0x00000010 // Only valid when used with a custom SetPixel function.
+                                   // This flag cannot be used in combination with
+                                   // ALPHA_BLEND or SHADOW_COLOR
+                                   // When this flag is used, the index to a color in the
+                                   // palette will be passed to your custom SetPixel
+                                   // function instead of the actual color.
 
 // Palette is an array of 256 DWORD's
 // For LoadPalette and LoadGrp, lpFileName may be a file in an open mpq archive
@@ -55,6 +63,23 @@ BOOL   GRPAPI WINAPI DestroyGrp(HANDLE hGrp);
 BOOL   GRPAPI WINAPI DrawGrp(HANDLE hGrp, HDC hdcDest, int nXDest, int nYDest, WORD nFrame, DWORD *dwPalette, DWORD dwFlags, DWORD dwAlpha);
 BOOL   GRPAPI WINAPI GetGrpInfo(HANDLE hGrp, GRPHEADER *GrpInfo);
 
+// A pointer to the raw image data to encode should be passed to lpImageData.  The size of
+// the buffer containing the data should be nFrames * wMaxWidth * wMaxHeight * sizeof(short)
+// and the values should be arranged row by row of the frame, with the top row first.
+// After all the rows of a frame have been put into the buffer, the rows of the next frame
+// go after it.  For transparent pixels, they should be set to -1.  All other pixels should
+// have the high order byte set to zero, meaning that they should not be negative and the
+// values should not exceed 255 (0xFF).  The values used for the colors are indexes into the
+// color palette.
+// Pass TRUE to bNoCompress if you need an uncompressed GRP.
+// Pass a pointer to a DWORD value to nGrpSize to receive the size in bytes of the resulting encoded GRP.
+// The return value of this function is actually a pointer to the GRP data.  This is what your
+// program should save to a file.  The size of this buffer is the value received by nGrpSize.
+// When your program is done with the returned buffer, it should call DestroyGrp on the
+// buffer that was returned by this function to free up the memory from it.
+// The pointer returned by this function can also be directly used by DrawGrp or GetGrpInfo.
+HANDLE GRPAPI WINAPI CreateGrp(signed short *lpImageData, WORD nFrames, WORD wMaxWidth, WORD wMaxHeight, BOOL bNoCompress, DWORD *nGrpSize);
+
 typedef COLORREF (WINAPI* GETPIXELPROC)(
   HDC hDC, // same value as hdcDest from DrawGrp,
 	       // does not need to be used as an HDC,
@@ -73,7 +98,7 @@ typedef void (WINAPI* SETPIXELPROC)(
 
 // Call these to have DrawGrp use custom functions for reading and drawing pixels
 // so that you can have it read from and write to a buffer, for example.
-void GRPAPI WINAPI SetFunctionGetPixel(GETPIXELPROC lpGetPixelProc);
+void GRPAPI WINAPI SetFunctionGetPixel(GETPIXELPROC lpGetPixelProc); // Only used with ALPHA_BLEND
 void GRPAPI WINAPI SetFunctionSetPixel(SETPIXELPROC lpSetPixelProc);
 
 // Call this to make a different Storm.dll-compatible MPQ library be used (like SFMPQ).
@@ -88,4 +113,3 @@ void   GRPAPI WINAPI FreeGrpApi();
 #endif
 
 #endif
-