ruby-iup 0.0.2 → 0.1.0

data/ext/iup-linux/include/im_convert.h

@@ -1,127 +1,142 @@
-/** \file
- * \brief Image Conversion
- *
- * See Copyright Notice in im_lib.h
- */
-
-#ifndef __IM_CONVERT_H
-#define __IM_CONVERT_H
-
-#include "im_image.h"
-
-#if	defined(__cplusplus)
-extern "C" {
-#endif
-
-                      
-/** \defgroup convert Image Conversion
- * \par
- * Converts one type of image into another. Can convert between color modes
- * and between data types.
- * \par
- * See \ref im_convert.h
- * \ingroup imgclass */
-
-
-/** Complex to real conversions
- * \ingroup convert */
-enum imComplex2Real 
-{
-  IM_CPX_REAL, 
-  IM_CPX_IMAG, 
-  IM_CPX_MAG, 
-  IM_CPX_PHASE
-};
-
-/** Predefined Gamma factors. Gamma can be any real number.
- * When gamma<0 use logarithmic, when gamma>0 use exponential.
- * gamma(x,g) = ((e^(g*x))-1)/(exp(g)-1)
- * gamma(x,g) = (log((g*x)+1))/(log(g+1))
- * \ingroup convert */
-enum imGammaFactor
-{
-  IM_GAMMA_LINEAR   = 0,
-  IM_GAMMA_LOGLITE  = -10,
-  IM_GAMMA_LOGHEAVY = -1000,
-  IM_GAMMA_EXPLITE  = 2,
-  IM_GAMMA_EXPHEAVY = 7
-};
-
-/** Predefined Cast Modes
- * \ingroup convert */
-enum imCastMode
-{
-  IM_CAST_MINMAX, /**< scan for min and max values */
-  IM_CAST_FIXED,  /**< use predefied 0-max values, see \ref color Color Manipulation. */
-  IM_CAST_DIRECT  /**< direct type cast the value. Only byte and ushort will be cropped. */
-};
-
-/** Changes the image data type, using a complex2real conversion, 
- * a gamma factor, and an abssolute mode (modulus). \n
- * When demoting the data type the function will scan for min/max values or use fixed values (cast_mode)
- * to scale the result according to the destiny range. \n
- * Except complex to real that will use only the complex2real conversion. \n
- * Images must be of the same size and color mode. \n
- * Returns IM_ERR_NONE, IM_ERR_DATA or IM_ERR_COUNTER, see also \ref imErrorCodes.
- * See also \ref imComplex2Real, \ref imGammaFactor and \ref imCastMode.
- *
- * \verbatim im.ConvertDataType(src_image: imImage, dst_image: imImage, cpx2real: number, gamma: number, abssolute: bool, cast_mode: number) -> error: number [in Lua 5] \endverbatim
- * \ingroup convert */
-int imConvertDataType(const imImage* src_image, imImage* dst_image, int cpx2real, float gamma, int abssolute, int cast_mode);
-
-/** Converts one color space to another. Images must be of the same size and data type. \n
- * CMYK can be converted to RGB only, and it is a very simple conversion. \n
- * All colors can be converted to Binary, the non zero gray values are converted to 1. \n
- * RGB to Map uses the median cut implementation from the free IJG JPEG software, copyright Thomas G. Lane. \n
- * All other color space conversions assume sRGB and CIE definitions. \n
- * Returns IM_ERR_NONE, IM_ERR_DATA or IM_ERR_COUNTER, see also \ref imErrorCodes.
- *
- * \verbatim im.ConvertColorSpace(src_image: imImage, dst_image: imImage) -> error: number [in Lua 5] \endverbatim
- * \ingroup convert */
-int imConvertColorSpace(const imImage* src_image, imImage* dst_image);
-
-/** Converts the image to its bitmap equivalent, 
- * uses \ref imConvertColorSpace and \ref imConvertDataType. \n
- * Returns IM_ERR_NONE, IM_ERR_DATA or IM_ERR_COUNTER, see also \ref imErrorCodes.
- * See also \ref imComplex2Real, \ref imGammaFactor and \ref imCastMode.
- *
- * \verbatim im.ConvertToBitmap(src_image: imImage, dst_image: imImage, cpx2real: number, gamma: number, abssolute: bool, cast_mode: number) -> error: number [in Lua 5] \endverbatim
- * \ingroup convert */
-int imConvertToBitmap(const imImage* src_image, imImage* dst_image, int cpx2real, float gamma, int abssolute, int cast_mode);
-
-
-
-/** \defgroup cnvutil Raw Data Conversion Utilities
- * \par
- * Utilities for raw data buffers.
- * \par
- * See \ref im_convert.h
- * \ingroup imagerep */
-
-
-/** Changes the packing of the data buffer.
- * \ingroup cnvutil */
-void imConvertPacking(const void* src_data, void* dst_data, int width, int height, int depth, int data_type, int src_is_packed);
-
-/** Changes in-place a MAP data into a RGB data. The data must have room for the RGB image. \n
- * depth can be 3 or 4. count=width*height. \n
- * Very usefull for OpenGL applications. 
- * \ingroup cnvutil */
-void imConvertMapToRGB(unsigned char* data, int count, int depth, int packed, long* palette, int palette_count);
-                       
-
-
-/* Converts a RGB bitmap into a map bitmap using the median cut algorithm.
- * Used only "im_convertcolor.cpp" implemented in "im_rgb2map.cpp". 
- * Internal function kept here because of the compatibility module. 
- * Will not be at the documentation. */
-int imConvertRGB2Map(int width, int height, 
-              unsigned char *red, unsigned char *green, unsigned char *blue, 
-              unsigned char *map, long *palette, int *palette_count);
-
-
-#if defined(__cplusplus)
-}
-#endif
-
-#endif
+/** \file
+ * \brief Image Conversion
+ *
+ * See Copyright Notice in im_lib.h
+ */
+
+#ifndef __IM_CONVERT_H
+#define __IM_CONVERT_H
+
+#include "im_image.h"
+
+#if	defined(__cplusplus)
+extern "C" {
+#endif
+
+                      
+/** \defgroup convert Image Conversion
+ * \par
+ * Converts one type of image into another. Can convert between color modes
+ * and between data types.
+ * \par
+ * See \ref im_convert.h
+ * \ingroup imgclass */
+
+
+/** Complex to real conversions
+ * \ingroup convert */
+enum imComplex2Real 
+{
+  IM_CPX_REAL, 
+  IM_CPX_IMAG, 
+  IM_CPX_MAG, 
+  IM_CPX_PHASE
+};
+
+/** Predefined Gamma factors. Gamma can be any real number.
+ * When gamma<0 use logarithmic, when gamma>0 use exponential.
+ * gamma(x,g) = ((e^(g*x))-1)/(exp(g)-1)
+ * gamma(x,g) = (log((g*x)+1))/(log(g+1))
+ * \ingroup convert */
+enum imGammaFactor
+{
+  IM_GAMMA_LINEAR   = 0,
+  IM_GAMMA_LOGLITE  = -10,
+  IM_GAMMA_LOGHEAVY = -1000,
+  IM_GAMMA_EXPLITE  = 2,
+  IM_GAMMA_EXPHEAVY = 7
+};
+
+/** Predefined Cast Modes
+ * \ingroup convert */
+enum imCastMode
+{
+  IM_CAST_MINMAX, /**< scan for min and max values */
+  IM_CAST_FIXED,  /**< use predefied 0-max values, see \ref color Color Manipulation. */
+  IM_CAST_DIRECT  /**< direct type cast the value. Only byte and ushort will be cropped. */
+};
+
+/** Changes the image data type, using a complex2real conversion, 
+ * a gamma factor, and an abssolute mode (modulus). \n
+ * When demoting the data type the function will scan for min/max values or use fixed values (cast_mode)
+ * to scale the result according to the destiny range. \n
+ * Except complex to real that will use only the complex2real conversion. \n
+ * Images must be of the same size and color mode. \n
+ * Returns IM_ERR_NONE, IM_ERR_DATA or IM_ERR_COUNTER, see also \ref imErrorCodes.
+ * See also \ref imComplex2Real, \ref imGammaFactor and \ref imCastMode.
+ *
+ * \verbatim im.ConvertDataType(src_image: imImage, dst_image: imImage, cpx2real: number, gamma: number, abssolute: boolean, cast_mode: number) -> error: number [in Lua 5] \endverbatim
+ * \verbatim im.ConvertDataTypeNew(image: imImage, data_type: number, cpx2real: number, gamma: number, abssolute: boolean, cast_mode: number) -> error: number, new_image: imImage  [in Lua 5] \endverbatim
+ * \ingroup convert */
+int imConvertDataType(const imImage* src_image, imImage* dst_image, int cpx2real, float gamma, int abssolute, int cast_mode);
+
+/** Converts one color space to another. Images must be of the same size and data type. \n
+ * CMYK can be converted to RGB only, and it is a very simple conversion. \n
+ * All colors can be converted to Binary, the non zero gray values are converted to 1. \n
+ * RGB to Map uses the median cut implementation from the free IJG JPEG software, copyright Thomas G. Lane. \n
+ * Alpha channel is considered and Transparency* attributes are converted to alpha channel. \n
+ * All other color space conversions assume sRGB and CIE definitions. \n
+ * Returns IM_ERR_NONE, IM_ERR_DATA or IM_ERR_COUNTER, see also \ref imErrorCodes.
+ *
+ * \verbatim im.ConvertColorSpace(src_image: imImage, dst_image: imImage) -> error: number [in Lua 5] \endverbatim
+ * \verbatim im.ConvertColorSpaceNew(image: imImage, color_space: number, has_alpha: boolean) -> error: number, new_image: imImage [in Lua 5] \endverbatim
+ * \ingroup convert */
+int imConvertColorSpace(const imImage* src_image, imImage* dst_image);
+
+/** Converts the image to its bitmap equivalent, 
+ * uses \ref imConvertColorSpace and \ref imConvertDataType. \n
+ * Returns IM_ERR_NONE, IM_ERR_DATA or IM_ERR_COUNTER, see also \ref imErrorCodes.
+ * See also \ref imComplex2Real, \ref imGammaFactor and \ref imCastMode. \n
+ * The function im.ConvertToBitmapNew uses the default convertion result from \ref imColorModeToBitmap if color_space is nil.
+ *
+ * \verbatim im.ConvertToBitmap(src_image: imImage, dst_image: imImage, cpx2real: number, gamma: number, abssolute: boolean, cast_mode: number) -> error: number [in Lua 5] \endverbatim
+ * \verbatim im.ConvertToBitmapNew(image: imImage, color_space: number, has_alpha: boolean, cpx2real: number, gamma: number, abssolute: boolean, cast_mode: number) -> error: number, new_image: imImage [in Lua 5] \endverbatim
+ * \ingroup convert */
+int imConvertToBitmap(const imImage* src_image, imImage* dst_image, int cpx2real, float gamma, int abssolute, int cast_mode);
+
+/** Returns an OpenGL compatible data buffer. Also returns the correspondant pixel format. \n
+ * The memory allocated is stored in the attribute "GLDATA" with BYTE type. And it will exists while the image exists. \n
+ * It can be cleared by setting the attribute to NULL. \n
+ * MAP images are converted to RGB, and BINARY images are converted to GRAY.
+ * Alpha channel is considered and Transparency* attributes are converted to alpha channel.
+ * So calculate depth from glformat, not from image depth.
+ *
+ * \verbatim image:GetOpenGLData() -> gldata: userdata, glformat: number [in Lua 5] \endverbatim
+ * \ingroup convert */
+void* imImageGetOpenGLData(const imImage* image, int *glformat);
+
+
+
+/** \defgroup cnvutil Raw Data Conversion Utilities
+ * \par
+ * Utilities for raw data buffers.
+ * \par
+ * See \ref im_convert.h
+ * \ingroup imagerep */
+
+
+/** Changes the packing of the data buffer. Both must have the same depth.
+ * \ingroup cnvutil */
+void imConvertPacking(const void* src_data, void* dst_data, int width, int height, int depth, int data_type, int src_is_packed);
+
+/** Changes in-place a MAP data into a RGB data. The data must have room for the RGB image. \n
+ * depth can be 3 or 4. count=width*height. \n
+ * \ingroup cnvutil */
+void imConvertMapToRGB(unsigned char* data, int count, int depth, int packed, long* palette, int palette_count);
+                       
+
+
+/* Converts a RGB bitmap into a map bitmap using the median cut algorithm.
+ * Used only "im_convertcolor.cpp" implemented in "im_rgb2map.cpp". 
+ * Internal function kept here because of the compatibility module. 
+ * Will not be at the documentation. */
+int imConvertRGB2Map(int width, int height, 
+              unsigned char *red, unsigned char *green, unsigned char *blue, 
+              unsigned char *map, long *palette, int *palette_count);
+
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif

data/ext/iup-linux/include/im_counter.h

@@ -1,69 +1,69 @@
-/** \file
- * \brief Processing Counter
- *
- * See Copyright Notice in im_lib.h
- */
-
-#ifndef __IM_COUNTER_H
-#define __IM_COUNTER_H
-
-#if	defined(__cplusplus)
-extern "C" {
-#endif
-
-
-/** \defgroup counter Counter 
- * \par
- * Used to notify the application that a step in the loading, saving or processing operation has been performed.
- * \par
- * See \ref im_counter.h
- * \ingroup util */
-
-/** Counter callback, informs the progress of the operation to the client. \n
- * Text contains a constant string that is NULL during normal counting, a title in the begining of a sequence 
- * and a message in the begining of a count.
- * Counter id identifies diferrent counters. \n
- * Progress in a count reports a value from 0 to 1000. If -1 indicates the start of a sequence of operations, 1001 ends the sequence. \n
- * If returns 0 the client should abort the operation. \n
- * If the counter is aborted, the callback will be called one last time at 1001.
- * \ingroup counter */
-typedef int (*imCounterCallback)(int counter, void* user_data, const char* text, int progress);
-
-/** Changes the counter callback. Returns old callback. \n
- * User data is changed only if not NULL.
- * \ingroup counter */
-imCounterCallback imCounterSetCallback(void* user_data, imCounterCallback counter_func);
-
-/** Begins a new count, or a partial-count in a sequence. \n
- * Calls the callback with "-1" and text=title, if it is at the top level. \n     
- * This is to be used by the operations. Returns a counter Id.
- * \ingroup counter */
-int imCounterBegin(const char* title);
-
-/** Ends a count, or a partial-count in a sequence. \n
- * Calls the callback with "1001", text=null, and releases the counter if it is at top level count. \n
- * \ingroup counter */
-void imCounterEnd(int counter);
-
-/** Increments a count. Must set the total first. \n
- * Calls the callback, text=message if it is the first increment for the count. \n
- * Returns 0 if the callback aborted, 1 if returns normally.
- * \ingroup counter */
-int imCounterInc(int counter);
-
-/** Set a specific count. Must set the total first. \n
- * Calls the callback, text=message if it is the first increment for the count. \n
- * Returns 0 if the callback aborted, 1 if returns normally.
- * \ingroup counter */
-int imCounterIncTo(int counter, int count);
-
-/** Sets the total increments of a count.
- * \ingroup counter */
-void imCounterTotal(int counter, int total, const char* message);
-
-
-#if defined(__cplusplus)
-}
-#endif
-
-#endif
+/** \file
+ * \brief Processing Counter
+ *
+ * See Copyright Notice in im_lib.h
+ */
+
+#ifndef __IM_COUNTER_H
+#define __IM_COUNTER_H
+
+#if	defined(__cplusplus)
+extern "C" {
+#endif
+
+
+/** \defgroup counter Counter 
+ * \par
+ * Used to notify the application that a step in the loading, saving or processing operation has been performed.
+ * \par
+ * See \ref im_counter.h
+ * \ingroup util */
+
+/** Counter callback, informs the progress of the operation to the client. \n
+ * Text contains a constant string that is NULL during normal counting, a title in the begining of a sequence 
+ * and a message in the begining of a count.
+ * Counter id identifies diferrent counters. \n
+ * Progress in a count reports a value from 0 to 1000. If -1 indicates the start of a sequence of operations, 1001 ends the sequence. \n
+ * If returns 0 the client should abort the operation. \n
+ * If the counter is aborted, the callback will be called one last time at 1001.
+ * \ingroup counter */
+typedef int (*imCounterCallback)(int counter, void* user_data, const char* text, int progress);
+
+/** Changes the counter callback. Returns old callback. \n
+ * User data is changed only if not NULL.
+ * \ingroup counter */
+imCounterCallback imCounterSetCallback(void* user_data, imCounterCallback counter_func);
+
+/** Begins a new count, or a partial-count in a sequence. \n
+ * Calls the callback with "-1" and text=title, if it is at the top level. \n     
+ * This is to be used by the operations. Returns a counter Id.
+ * \ingroup counter */
+int imCounterBegin(const char* title);
+
+/** Ends a count, or a partial-count in a sequence. \n
+ * Calls the callback with "1001", text=null, and releases the counter if it is at top level count. \n
+ * \ingroup counter */
+void imCounterEnd(int counter);
+
+/** Increments a count. Must set the total first. \n
+ * Calls the callback, text=message if it is the first increment for the count. \n
+ * Returns 0 if the callback aborted, 1 if returns normally.
+ * \ingroup counter */
+int imCounterInc(int counter);
+
+/** Set a specific count. Must set the total first. \n
+ * Calls the callback, text=message if it is the first increment for the count. \n
+ * Returns 0 if the callback aborted, 1 if returns normally.
+ * \ingroup counter */
+int imCounterIncTo(int counter, int count);
+
+/** Sets the total increments of a count.
+ * \ingroup counter */
+void imCounterTotal(int counter, int total, const char* message);
+
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif

data/ext/iup-linux/include/im_dib.h

@@ -1,195 +1,195 @@
-/** \file
- * \brief Windows DIB (Device Independent Bitmap)
- *
- * See Copyright Notice in im_lib.h
- */
-
-#ifndef __IM_DIB_H
-#define __IM_DIB_H
-
-#if	defined(__cplusplus)
-extern "C" {
-#endif
-
-
-/** \defgroup dib Windows DIB
- *
- * \par
- * Windows DIBs in memory are handled just like a BMP file without the file header. \n
- * These functions will work only in Windows. They are usefull for interchanging data 
- * with the clipboard, with capture drivers, with the AVI and WMF file formats and others.
- * \par
- * Supported DIB aspects:
- * \li bpp must be 1, 4, 8, 16, 24, or 32.
- * \li BITMAPV4HEADER or BITMAPV5HEADER are handled but ignored. \n
- * \li BITMAPCOREHEADER is not handled .
- * \li BI_JPEG and BI_PNG compressions are not handled. 
- * \li biHeight can be negative, compression can be RLE only if created
- *   from imDibCreateReference, imDibPasteClipboard, imDibLoadFile. 
- * \li can not encode/decode Images to/from RLE compressed Dibs. 
- * \li if working with RLE Dibs bits_size is greatter than used. 
- * \li the resolution of a new Dib is taken from the screen. 
- * \li SetDIBitsToDevice(start_scan is 0, scan_lines is dib->bmih->biHeight).  
- * \li StretchDIBits(use always DIB_RGB_COLORS). 
- * \li CreateDIBPatternBrushPt(packed_dib is dib->dib). 
- * \par
- * Must include <windows.h> before using these functions. \n 
- * Check <wingdi.h> for structures and definitions. 
- * \par
- * See \ref im_dib.h
- * \ingroup util */
-
-
-/** \brief Windows DIB Structure
- *
- * \par
- * Handles a DIB in memory. \n
- * The DIB is stored in only one buffer.
- * The secondary members are pointers to the main buffer.
- * \ingroup dib */
-typedef struct _imDib 
-{
-  HGLOBAL           handle;        /**< The windows memory handle */
-  BYTE*             dib;           /**< The DIB as it is defined in memory */
-  int               size;          /**< Full size in memory */
-                                  
-  BITMAPINFO*       bmi;           /**< Bitmap Info = Bitmap Info Header + Palette */
-  BITMAPINFOHEADER* bmih;          /**< Bitmap Info Header */
-  RGBQUAD*          bmic;          /**< Bitmap Info Colors = Palette */
-  BYTE*             bits;	         /**< Bitmap Bits */
-                                  
-  int               palette_count; /**< number of colors in the palette */
-  int               bits_size;     /**< size in bytes of the Bitmap Bits */
-  int               line_size;     /**< size in bytes of one line, includes padding */
-  int               pad_size;      /**< number of bytes remaining in the line, lines are in a word boundary */
-                                  
-  int               is_reference;  /**< only a reference, do not free pointer */
-} imDib; 
-
-/** Creates a new DIB. \n
- * use bpp=-16/-32 to allocate space for BITFLIEDS.
- * \ingroup dib */
-imDib* imDibCreate(int width, int height, int bpp);     
-
-/** Duplicates the DIB contents in a new DIB.
- * \ingroup dib */
-imDib* imDibCreateCopy(const imDib* dib);
-
-/** Creates a DIB using an already allocated memory. \n
- * "bmi" must be a pointer to BITMAPINFOHEADER. \n
- * "bits" can be NULL if it is inside "bmi" after the palette.
- * \ingroup dib */
-imDib* imDibCreateReference(BYTE* bmi, BYTE* bits);     
-
-/** Creates a DIB section for drawing porposes. \n
- * Returns the image handle also created.
- * \ingroup dib */
-imDib* imDibCreateSection(HDC hDC, HBITMAP *image, int width, int height, int bpp);
-
-/** Destroy the DIB
- * \ingroup dib */
-void imDibDestroy(imDib* dib);                                 
-
-/** DIB GetPixel function definition. \n 
- * the DWORD is a raw copy of the bits, use (unsigned char*)&pixel
- * \ingroup dib */
-typedef unsigned int (*imDibLineGetPixel)(unsigned char* line, int col);
-
-/** Returns a function to read pixels from a DIB line.
- * \ingroup dib */
-imDibLineGetPixel imDibLineGetPixelFunc(int bpp);  
-
-/** DIB SetPixel function definition
- * \ingroup dib */
-typedef void (*imDibLineSetPixel)(unsigned char* line, int col, unsigned int pixel);
-
-/** Returns a function to write pixels into a DIB line.
- * \ingroup dib */
-imDibLineSetPixel imDibLineSetPixelFunc(int bpp);  
-
-/** Creates a DIB from a image handle and a palette handle.
- * \ingroup dib */
-imDib* imDibFromHBitmap(const HBITMAP image, const HPALETTE hPalette); 
-
-/** Creates a image handle from a DIB.
- * \ingroup dib */
-HBITMAP imDibToHBitmap(const imDib* dib);
-
-/** Returns a Logical palette from the DIB palette. \n
- * DIB bpp must be <=8.
- * \ingroup dib */
-HPALETTE imDibLogicalPalette(const imDib* dib);
-
-/** Captures the screen into a DIB.
- * \ingroup dib */
-imDib* imDibCaptureScreen(int x, int y, int width, int height);
-
-/** Transfer the DIB to the clipboard. \n 
- * "dib" pointer can not be used after, or use imDibCopyClipboard(imDibCreateCopy(dib)).
- * Warning: Clipboard functions in C++ can fail with Visual C++ /EHsc (Enable C++ Exceptions)
-* \ingroup dib */
-void imDibCopyClipboard(imDib* dib); 
-
-/** Creates a reference for the DIB in the clipboard if any. Returns NULL otherwise.
- * Warning: Clipboard functions in C++ can fail with Visual C++ /EHsc (Enable C++ Exceptions)
- * \ingroup dib */
-imDib* imDibPasteClipboard(void);           
-
-/** Checks if there is a dib at the clipboard.
- * \ingroup dib */
-int imDibIsClipboardAvailable(void);
-
-/** Saves the DIB into a file ".bmp".
- * \ingroup dib */
-int imDibSaveFile(const imDib* dib, const char* filename);
-
-/** Creates a DIB from a file ".bmp".
- * \ingroup dib */
-imDib* imDibLoadFile(const char* filename);
-
-/** Converts a DIB into an RGBA image. alpha is optional. bpp must be >8. \n 
- * alpha is used only when bpp=32.
- * \ingroup dib */
-void imDibDecodeToRGBA(const imDib* dib, unsigned char* red, unsigned char* green, unsigned char* blue, unsigned char* alpha);
-
-/** Converts a DIB into an indexed image. bpp must be <=8. colors must have room for at least 256 colors. 
- * colors is rgb packed (RGBRGBRGB...)
- * \ingroup dib */
-void imDibDecodeToMap(const imDib* dib, unsigned char* map, long* palette);
-
-/** Converts an RGBA image into a DIB. alpha is optional. bpp must be >8. \n
- * alpha is used only when bpp=32.
- * \ingroup dib */
-void imDibEncodeFromRGBA(imDib* dib, const unsigned char* red, const unsigned char* green, const unsigned char* blue, const unsigned char* alpha);
-
-/** Converts an indexed image into a DIB. bpp must be <=8. \n
- * colors is rgb packed (RGBRGBRGB...)
- * \ingroup dib */
-void imDibEncodeFromMap(imDib* dib, const unsigned char* map, const long* palette, int palette_count);
-
-/** Converts a IM_RGB packed image, with or without alpha, into a DIB.
- * \ingroup dib */
-void imDibEncodeFromBitmap(imDib* dib, const unsigned char* data);
-
-/** Converts a DIB into IM_RGB packed image, with or without alpha.
- * \ingroup dib */
-void imDibDecodeToBitmap(const imDib* dib, unsigned char* data);
-
-#ifdef __IM_IMAGE_H
-/* You must include "im_image.h" before this header to enable these declarations. */
-
-/** Creates a imImage from the dib data.
- * \ingroup dib */
-imImage* imDibToImage(const imDib* dib);
-
-/** Creates a Dib from the image. It must be a bitmap image.
- * \ingroup dib */
-imDib* imDibFromImage(const imImage* image);
-
-#endif
-
-#if defined(__cplusplus)
-}
-#endif
-
-#endif
+/** \file
+ * \brief Windows DIB (Device Independent Bitmap)
+ *
+ * See Copyright Notice in im_lib.h
+ */
+
+#ifndef __IM_DIB_H
+#define __IM_DIB_H
+
+#if	defined(__cplusplus)
+extern "C" {
+#endif
+
+
+/** \defgroup dib Windows DIB
+ *
+ * \par
+ * Windows DIBs in memory are handled just like a BMP file without the file header. \n
+ * These functions will work only in Windows. They are usefull for interchanging data 
+ * with the clipboard, with capture drivers, with the AVI and WMF file formats and others.
+ * \par
+ * Supported DIB aspects:
+ * \li bpp must be 1, 4, 8, 16, 24, or 32.
+ * \li BITMAPV4HEADER or BITMAPV5HEADER are handled but ignored. \n
+ * \li BITMAPCOREHEADER is not handled .
+ * \li BI_JPEG and BI_PNG compressions are not handled. 
+ * \li biHeight can be negative, compression can be RLE only if created
+ *   from imDibCreateReference, imDibPasteClipboard, imDibLoadFile. 
+ * \li can not encode/decode Images to/from RLE compressed Dibs. 
+ * \li if working with RLE Dibs bits_size is greatter than used. 
+ * \li the resolution of a new Dib is taken from the screen. 
+ * \li SetDIBitsToDevice(start_scan is 0, scan_lines is dib->bmih->biHeight).  
+ * \li StretchDIBits(use always DIB_RGB_COLORS). 
+ * \li CreateDIBPatternBrushPt(packed_dib is dib->dib). 
+ * \par
+ * Must include <windows.h> before using these functions. \n 
+ * Check <wingdi.h> for structures and definitions. 
+ * \par
+ * See \ref im_dib.h
+ * \ingroup util */
+
+
+/** \brief Windows DIB Structure
+ *
+ * \par
+ * Handles a DIB in memory. \n
+ * The DIB is stored in only one buffer.
+ * The secondary members are pointers to the main buffer.
+ * \ingroup dib */
+typedef struct _imDib 
+{
+  HGLOBAL           handle;        /**< The windows memory handle */
+  BYTE*             dib;           /**< The DIB as it is defined in memory */
+  int               size;          /**< Full size in memory */
+                                  
+  BITMAPINFO*       bmi;           /**< Bitmap Info = Bitmap Info Header + Palette */
+  BITMAPINFOHEADER* bmih;          /**< Bitmap Info Header */
+  RGBQUAD*          bmic;          /**< Bitmap Info Colors = Palette */
+  BYTE*             bits;	         /**< Bitmap Bits */
+                                  
+  int               palette_count; /**< number of colors in the palette */
+  int               bits_size;     /**< size in bytes of the Bitmap Bits */
+  int               line_size;     /**< size in bytes of one line, includes padding */
+  int               pad_size;      /**< number of bytes remaining in the line, lines are in a word boundary */
+                                  
+  int               is_reference;  /**< only a reference, do not free pointer */
+} imDib; 
+
+/** Creates a new DIB. \n
+ * use bpp=-16/-32 to allocate space for BITFLIEDS.
+ * \ingroup dib */
+imDib* imDibCreate(int width, int height, int bpp);     
+
+/** Duplicates the DIB contents in a new DIB.
+ * \ingroup dib */
+imDib* imDibCreateCopy(const imDib* dib);
+
+/** Creates a DIB using an already allocated memory. \n
+ * "bmi" must be a pointer to BITMAPINFOHEADER. \n
+ * "bits" can be NULL if it is inside "bmi" after the palette.
+ * \ingroup dib */
+imDib* imDibCreateReference(BYTE* bmi, BYTE* bits);     
+
+/** Creates a DIB section for drawing porposes. \n
+ * Returns the image handle also created.
+ * \ingroup dib */
+imDib* imDibCreateSection(HDC hDC, HBITMAP *image, int width, int height, int bpp);
+
+/** Destroy the DIB
+ * \ingroup dib */
+void imDibDestroy(imDib* dib);                                 
+
+/** DIB GetPixel function definition. \n 
+ * the DWORD is a raw copy of the bits, use (unsigned char*)&pixel
+ * \ingroup dib */
+typedef unsigned int (*imDibLineGetPixel)(unsigned char* line, int col);
+
+/** Returns a function to read pixels from a DIB line.
+ * \ingroup dib */
+imDibLineGetPixel imDibLineGetPixelFunc(int bpp);  
+
+/** DIB SetPixel function definition
+ * \ingroup dib */
+typedef void (*imDibLineSetPixel)(unsigned char* line, int col, unsigned int pixel);
+
+/** Returns a function to write pixels into a DIB line.
+ * \ingroup dib */
+imDibLineSetPixel imDibLineSetPixelFunc(int bpp);  
+
+/** Creates a DIB from a image handle and a palette handle.
+ * \ingroup dib */
+imDib* imDibFromHBitmap(const HBITMAP image, const HPALETTE hPalette); 
+
+/** Creates a image handle from a DIB.
+ * \ingroup dib */
+HBITMAP imDibToHBitmap(const imDib* dib);
+
+/** Returns a Logical palette from the DIB palette. \n
+ * DIB bpp must be <=8.
+ * \ingroup dib */
+HPALETTE imDibLogicalPalette(const imDib* dib);
+
+/** Captures the screen into a DIB.
+ * \ingroup dib */
+imDib* imDibCaptureScreen(int x, int y, int width, int height);
+
+/** Transfer the DIB to the clipboard. \n 
+ * "dib" pointer can not be used after, or use imDibCopyClipboard(imDibCreateCopy(dib)).
+ * Warning: Clipboard functions in C++ can fail with Visual C++ /EHsc (Enable C++ Exceptions)
+* \ingroup dib */
+void imDibCopyClipboard(imDib* dib); 
+
+/** Creates a reference for the DIB in the clipboard if any. Returns NULL otherwise.
+ * Warning: Clipboard functions in C++ can fail with Visual C++ /EHsc (Enable C++ Exceptions)
+ * \ingroup dib */
+imDib* imDibPasteClipboard(void);           
+
+/** Checks if there is a dib at the clipboard.
+ * \ingroup dib */
+int imDibIsClipboardAvailable(void);
+
+/** Saves the DIB into a file ".bmp".
+ * \ingroup dib */
+int imDibSaveFile(const imDib* dib, const char* filename);
+
+/** Creates a DIB from a file ".bmp".
+ * \ingroup dib */
+imDib* imDibLoadFile(const char* filename);
+
+/** Converts a DIB into an RGBA image. alpha is optional. bpp must be >8. \n 
+ * alpha is used only when bpp=32.
+ * \ingroup dib */
+void imDibDecodeToRGBA(const imDib* dib, unsigned char* red, unsigned char* green, unsigned char* blue, unsigned char* alpha);
+
+/** Converts a DIB into an indexed image. bpp must be <=8. colors must have room for at least 256 colors. 
+ * colors is rgb packed (RGBRGBRGB...)
+ * \ingroup dib */
+void imDibDecodeToMap(const imDib* dib, unsigned char* map, long* palette);
+
+/** Converts an RGBA image into a DIB. alpha is optional. bpp must be >8. \n
+ * alpha is used only when bpp=32.
+ * \ingroup dib */
+void imDibEncodeFromRGBA(imDib* dib, const unsigned char* red, const unsigned char* green, const unsigned char* blue, const unsigned char* alpha);
+
+/** Converts an indexed image into a DIB. bpp must be <=8. \n
+ * colors is rgb packed (RGBRGBRGB...)
+ * \ingroup dib */
+void imDibEncodeFromMap(imDib* dib, const unsigned char* map, const long* palette, int palette_count);
+
+/** Converts a IM_RGB packed image, with or without alpha, into a DIB.
+ * \ingroup dib */
+void imDibEncodeFromBitmap(imDib* dib, const unsigned char* data);
+
+/** Converts a DIB into IM_RGB packed image, with or without alpha.
+ * \ingroup dib */
+void imDibDecodeToBitmap(const imDib* dib, unsigned char* data);
+
+#ifdef __IM_IMAGE_H
+/* You must include "im_image.h" before this header to enable these declarations. */
+
+/** Creates a imImage from the dib data.
+ * \ingroup dib */
+imImage* imDibToImage(const imDib* dib);
+
+/** Creates a Dib from the image. It must be a bitmap image.
+ * \ingroup dib */
+imDib* imDibFromImage(const imImage* image);
+
+#endif
+
+#if defined(__cplusplus)
+}
+#endif
+
+#endif