diff --git a/DevIL-docs/.cvsignore b/DevIL-docs/.cvsignore
new file mode 100644
index 00000000..3a4edf69
--- /dev/null
+++ b/DevIL-docs/.cvsignore
@@ -0,0 +1 @@
+.project
diff --git a/DevIL-docs/Design Documents/New File Formats.pdf b/DevIL-docs/Design Documents/New File Formats.pdf
new file mode 100644
index 00000000..c5bcbfcc
Binary files /dev/null and b/DevIL-docs/Design Documents/New File Formats.pdf differ
diff --git a/DevIL-docs/Design Documents/New File Formats.tex b/DevIL-docs/Design Documents/New File Formats.tex
new file mode 100644
index 00000000..a64bd3b5
--- /dev/null
+++ b/DevIL-docs/Design Documents/New File Formats.tex
@@ -0,0 +1,84 @@
+\documentclass[letterpaper,10pt]{article}
+\title{Adding New File Formats to DevIL}
+\author{Denton Woods}
+\date{March 2009}
+\usepackage{amsmath,graphicx,fullpage}
+\begin{document}
+\maketitle
+
+\section*{Adding the .c or .cpp File}
+Make sure that the new .c or .cpp file is added to the Subversion repository using the \emph{svn add} command.
+
+\subsubsection*{Microsoft Visual C++}
+The .c or .cpp file must be added to the Microsoft Visual C++ 9 projects \emph{src-IL/projects/msvc9/ImageLib Unicode.sln} and \emph{src-IL/projects/msvc9/ImageLib.sln}. The file must also be added to the MSVC++ 8 projects \emph{src-IL/projects/msvc8/ImageLib Unicode.sln} and \emph{src-IL/projects/msvc8/ImageLib.sln}.
+
+\subsubsection*{Linux, Cygwin and Mac OS X}
+For the Linux/Cygwin/Mac OS X makefile system, add the filename to the libIL\_la\_SOURCES line of lib/Makefile.am.
+
+
+\section*{configure.ac}
+Add the format to configure.ac around line 320, with a description.
+
+
+\section*{DevIL_manual.texi}
+Add the file format to the appendix entitled \emph{Supported File Formats} in the TexInfo manual.
+
+
+\section*{il.h}
+Add the appropriate IL\_XXX define to il.h (around line 240). Make sure to include a commented description in Doxygen format.
+
+
+\section*{il\_internal.h}
+Add the function declarations to il\_internal.h around line 224.
+
+
+\section*{il\_io.c}
+
+\subsubsection*{Validation}
+If \textbf{ilIsValid*} functions are created for the new format, the function calls must be implemented in \textbf{ilDetermineTypeF}, \textbf{ilDetermineTypeL}, \textbf{ilIsValid}, \textbf{ilIsValidF} and \textbf{ilIsValidL}.
+
+\subsubsection*{Loading}
+The first thing that needs to be added is checks for the extensions in \textbf{ilTypeFromExt}.
+
+Next add the appropriate function calls to \textbf{ilLoad}, \textbf{ilLoadF}, \textbf{ilLoadL} and \textbf{ilLoadImage}. Make sure to put the IL\_XXX define in the Doxygen comment before the function!
+
+\subsubsection*{Saving}
+Add the function calls to \textbf{ilSave}, \textbf{ilSaveF}, \textbf{ilSaveL} and \textbf{ilSaveImage}. Make sure to put the IL\_XXX define in the Doxygen comment before the function!
+
+
+\section*{il\_states.c and il\_states.h}
+Change \_ilLoadExt and/or \_ilSaveExt to include the new format name in il\_states.c. Also add the format to il\_states.h.
+
+\section*{Website}
+Add to the list of types the DevIL can load on the About and the Features pages.
+
+
+\section*{Summary of Changes to Make}
+\begin{itemize}
+\item Run \emph{svn ci}.
+\item Add to MSVC++ 8 projects.
+\item Add to MSVC++ 9 projects.
+\item Add to lib/Makefile.am sources line.
+\item Add to configure.ac with description.
+\item Add to DevIL_manual.texi appendix.
+\item Add IL\_XXX to il.h.
+\item Add function declarations to il\_internal.h.
+\item Add validation functions if they exist.
+\item For loading functions:
+ \begin {itemize}
+ \item \textbf{ilTypeFromExt}
+ \item \textbf{ilLoad}, \textbf{ilLoadF}, \textbf{ilLoadL} and \textbf{ilLoadImage}
+ \item Add Doxygen comments to \textbf{ilLoad}, \textbf{ilLoadF}, \textbf{ilLoadL} and \textbf{ilLoadImage}.
+ \end {itemize}
+\item For saving functions:
+ \begin {itemize}
+ \item \textbf{ilSave}, \textbf{ilSaveF}, \textbf{ilSaveL} and \textbf{ilSaveImage}
+ \item Add Doxygen comments to \textbf{ilSave}, \textbf{ilSaveF}, \textbf{ilSaveL} and \textbf{ilSaveImage}.
+ \end {itemize}
+\item Add to il\_states.c and il\_states.h.
+\item Add to website (about and features pages).
+\end{itemize}
+
+
+\end{document}
+
diff --git a/DevIL-docs/Design Documents/Version Number.pdf b/DevIL-docs/Design Documents/Version Number.pdf
new file mode 100644
index 00000000..3bf0394b
Binary files /dev/null and b/DevIL-docs/Design Documents/Version Number.pdf differ
diff --git a/DevIL-docs/Design Documents/Version Number.tex b/DevIL-docs/Design Documents/Version Number.tex
new file mode 100644
index 00000000..84ec41b9
--- /dev/null
+++ b/DevIL-docs/Design Documents/Version Number.tex
@@ -0,0 +1,34 @@
+\documentclass[letterpaper,10pt]{article}
+\title{Changing DevIL Version Number}
+\author{Denton Woods}
+\date{March 2009}
+\usepackage{amsmath,graphicx,fullpage}
+\begin{document}
+\maketitle
+
+\section*{Microsoft Visual C++ Resource Files}
+\subsection*{Unicode Resource Files}
+\emph{src-IL/msvc9/IL Unicode.rc}, \emph{src-IL/msvc8/IL Unicode.rc}, \emph{src-ILU/msvc9/ILU Unicode.rc}, \emph{src-ILU/msvc8/ILU Unicode.rc}, \emph{src-ILUT/msvc9/ILUT Unicode.rc} and \emph{src-ILUT/msvc8/ILUT Unicode.rc} must all be updated with the new version number. Look for the lines starting with \emph{FILEVERSION}, \emph{PRODUCTVERSION}, \emph{VALUE $\backslash$``FileVersion$\backslash$''}, \emph{VALUE $\backslash$``ProductVersion$\backslash$''} and \emph{IDC\_OPENIL}.
+
+\subsection*{Ansi Resource Files}
+\emph{src-IL/msvc9/IL.rc}, \emph{src-IL/msvc8/IL.rc}, \emph{src-ILU/msvc9/ILU.rc}, \emph{src-ILU/msvc8/ILU.rc}, \emph{src-ILUT/msvc9/ILUT.rc} and \emph{src-ILUT/msvc8/ILUT.rc} all have the same format as the Unicode resource files.
+
+
+\section*{configure.ac}
+Change the version number on line 12.
+
+
+\section*{IL.h, ILU.h, ILUT.h}
+At about line 164 in IL.h, change IL\_VERSION\_ and IL\_VERSION to reflect the new version number. The equivalent lines are at line 40 in ilu.h and line 32 in ilut.h.
+
+
+\section*{README}
+Change the first line of README to the new version number.
+
+
+\section*{il\_states.c, ilu\_states.c and ilut\_states.c}
+At the top of each of these files, change the \_il(u(t))Vendor and \_il(u(t))Version lines to the new version number.
+
+
+\end{document}
+
diff --git a/DevIL-docs/DevIL Manual.doc b/DevIL-docs/DevIL Manual.doc
new file mode 100644
index 00000000..5c01800e
Binary files /dev/null and b/DevIL-docs/DevIL Manual.doc differ
diff --git a/DevIL-docs/DevIL Manual.pdf b/DevIL-docs/DevIL Manual.pdf
new file mode 100644
index 00000000..f0233275
Binary files /dev/null and b/DevIL-docs/DevIL Manual.pdf differ
diff --git a/DevIL-docs/DevIL Reference Guide - French Version.doc b/DevIL-docs/DevIL Reference Guide - French Version.doc
new file mode 100644
index 00000000..31e5b4f7
Binary files /dev/null and b/DevIL-docs/DevIL Reference Guide - French Version.doc differ
diff --git a/DevIL-docs/DevIL Reference Guide.doc b/DevIL-docs/DevIL Reference Guide.doc
new file mode 100644
index 00000000..c9c26ffc
Binary files /dev/null and b/DevIL-docs/DevIL Reference Guide.doc differ
diff --git a/DevIL-docs/DevIL Reference Guide.pdf b/DevIL-docs/DevIL Reference Guide.pdf
new file mode 100644
index 00000000..b89dc1a6
Binary files /dev/null and b/DevIL-docs/DevIL Reference Guide.pdf differ
diff --git a/DevIL-docs/DevilDoc.dtd b/DevIL-docs/DevilDoc.dtd
new file mode 100755
index 00000000..0de86c14
--- /dev/null
+++ b/DevIL-docs/DevilDoc.dtd
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/DevIL-docs/DevilDoc.xml b/DevIL-docs/DevilDoc.xml
new file mode 100644
index 00000000..0eaef5b4
--- /dev/null
+++ b/DevIL-docs/DevilDoc.xml
@@ -0,0 +1,3163 @@
+
+
+
+
+
+
+ ilActiveImage
+ ILboolean
+ ma
+ ilActiveImage sets the current image to be an image in an animation chain
+
+
+
+
+
+
+
+
+
+
+
+
+ ilActiveMipmap
+ ILboolean
+
+ ilActiveMipmap sets a mipmap of the image as the current mipmap. Currently, the only way to generate mipmaps is by calling iluBuildMipmaps. If neither function has been called for the current image, no mipmaps exist for it. If Number is 0, then the current base image is set.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilBindImage
+ ILvoid
+
+ The ilBindImage function creates a named image. Image names are ILuint's, with zero being reserved as the default image. The default image is generated by ilCreateDefaultTex. The only reason the default image would be NULL is if OpenIL could not create the default image, due to memory constraints of the system, so always heed the IL_OUT_OF_MEMORY error. Any dimension image may be bound with ilBindImage. When ilBindImage is called, the bound image remains bound until ilBindImage is called again with a different value in Image.
+
+
+
+
+
+
+
+
+
+
+
+ ilClearImage
+ ILboolean
+ ilClearImage simply clears the image to the colours specified in ilClearColour. If the current image is of format IL_COLOR_INDEX, the image is cleared to all zeros, and the palette is changed to one entry of all zeros. If the current image is of format IL_LUMINANCE, the image is cleared to all zeros.
+
+
+
+
+
+
+
+
+
+
+ ilConvertImage
+ ILboolean
+
+
+ ilConvertImage converts the current bound image from its format/type to DestFormat and DestType. Almost all conversions are allowable.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilCopyImage
+ ILboolean
+
+ ilCopyImage copies the attributes and data from the image named in Src. The same image bound before calling ilCopyImage remains bound afterward.
+
+
+
+
+
+
+
+
+
+
+ ilCopyPixels
+ ILvoid
+
+
+
+
+
+
+
+
+
+ ilCopyPixels has very simple behaviour. It simply copies a block of pixels from the current image to the Data buffer. XOff, YOff and ZOff can be used to skip a certain number of pixels in each respective direction. If XOff + Width, YOff + Height and/or ZOff + Depth is greater than the current image's width, height or depth, only the current image's width, height or depth number of pixels will be copied to Data.
+
+
+
+
+
+
+
+
+
+
+
+ ilDefaultImage
+ ILboolean
+ ilDefaultImage creates an ugly 64x64 image of 8x8 black and yellow squares to form a checkerboard pattern. In future versions of OpenIL, there may be an option that will load this image if an image-loading function failed (unless memory could not be allocated). This way, the user can easily tell if an image was not loaded. Plus, the calling program can continue normally, even though it will have an ugly image. ;-)
+
+
+
+
+
+
+
+
+
+
+ ilDeleteImages
+ ILvoid
+
+
+ ilDeleteImages deletes Num image names specified in Images. After a texture is deleted, its characteristics and dimensions are undefined, and the name may be reused byilGenImages. ilDeleteImages ignores zeros and out-of-bounds image names. If the current image is deleted, the binding reverts to the default image (image name of 0).
+
+
+
+
+
+
+
+
+
+ ilEnable
+ ILboolean
+
+ ilEnable enables a mode specified by Mode. This function is identical to it's OpenGL counterpart glEnable.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilDisable
+ ILboolean
+
+ ilDisable disables a mode specified by Mode. This function is identical to it's OpenGL counterpart glDisable.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilGenImages
+ ILvoid
+
+
+ ilGenImages stores Num image names in Images. The names stored are not necessarily contiguous, and names can have been deleted via ilDeleteImages beforehand. The image names stored in Images can be used with ilBindImage after calling ilGenImages. After calling ilGenImages, all image dimensions and features are undefined.
+
+
+
+
+
+
+
+
+
+ ilDeleteImage
+ ILvoid
+
+ ilDeleteImage is a convenience function to delete a single image instead of calling ilDeleteImages
+
+
+
+
+
+
+
+
+
+
+ ilGenImage
+ ILvoid
+
+ ilGenImage is a convenience function to delete a single image instead of calling ilGenImages
+
+
+
+
+
+
+
+ ilGetBoolean
+ ILboolean
+
+ ilGetBoolean returns the value of a selected mode.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilGetBooleanv
+ ILvoid
+
+
+ ilGetBooleanv function returns the mode value in the Param parameter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilGetIntegerv
+ ILvoid
+
+
+ ilGetIntegerv function returns the mode value in the Param parameter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilGetInteger
+ ILint
+
+ ilGetInteger returns the value of a selected mode.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilGetError
+ ILenum
+
+ ilGetError returns the value of the last error on the error stack. If no error has occurred, IL_NO_ERROR is returned. Initially, the error stack is set to IL_NO_ERROR. When ilGetError is called, the last error on the error stack is "popped off". Errors that occur in ILU and ILUT are also reported through ilGetError. ilGetError only returns something other than IL_NO_ERROR if detectable errors have occurred.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilGetString
+ const char *
+ ilGetString returns a constant human-readable string describing the current OpenIL implementation.
+
+
+
+
+
+
+
+
+
+
+ ilIsEnabled
+ ILboolean
+ ilIsEnabled returns whether the mode indicated by Mode is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilIsDisabled
+ ILboolean
+ ilIsDisabled returns whether the mode indicated by Mode is disabled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilOriginFunc
+ ILboolean
+ ilOriginFunc sets the origin to be used when loading all images, so that any image with a different origin will be flipped to have the set origin. This behaviour is actually disabled by default but can be enabled using ilEnable with the IL_ORIGIN_SET parameter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilLoadImage
+ ILboolean
+ The ilLoadImage function allows a general interface to the specific internal file-loading routines. The approach ilLoadImage takes toward determining image types is three-pronged. First, it finds the extension and checks to see if any user-registered functions (registered through ilRegisterLoad) match the extension. If nothing matches, it takes the extension and determines which function to call based on it. Lastly, it attempts to identify the image based on various image header verification functions, such as ilIsValidPngF. If all this checking fails, IL_FALSE is returned with no modification to the current bound image.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilPopAttrib
+ ILvoid
+ ilPopAttrib pops the last pushed stack entry off the stack and copies the bits specified when pushed by ilPushAttrib to the previous set of states.
+
+
+
+
+
+
+
+
+ ilPushAttrib
+ ILvoid
+ ilPushAttrib pushes a new set of modes and attributes onto the state stack, allowing for "a fresh start".
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSaveImage
+ ILboolean
+ The ilSaveImage function allows a general interface to the specific internal file saving routines. Based on the extension, OpenIL will save that type of file (e.g. Targa file saved when the extension is "tga").
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSetRead
+ ILvoid
+ ilSetRead was primarily designed to allow languages other than C/C++ access to DevIL's file-reading functions, since other languages do not use stdio.h's FILE* struct. This function can also double usefully in instances where filetypes other than FILE* are used, such as Windows file handles and C++ istreams. Simply provide an alternative to each of the functions needed by DevIL. The "special" datatype ILHANDLE is passed to these functions when used, so any internal datatype used by the differing language (or file handle) can be used.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilInit
+ ILvoid
+ ilInit starts DevIL and must be called prior to using DevIL, or else DevIL will probably crash when you attempt to use it.
+
+
+
+
+
+
+
+ ilTexImage
+ ILboolean
+
+
+
+
+
+
+
+ Any current image data is destroyed by ilTexImage and replaced by a new image with the attributes specified. The new image data has undefined values. To set the new image data to a certain value, use ilClearImage or ilClearImageTo.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSetData
+ ILboolean
+
+ ilSetData just updates the current bound image data (bound by ilBindImage) with new data of the same size. This way new memory does not have to be allocated, so transfers are much faster.
+
+
+
+
+
+
+ ilClearColour
+ ILvoid
+
+
+
+
+ ilClearColour sets the current clearing colour to be used by future calls to ilClearImage. iluRotate and iluEnlargeCanvas both use these values to clear blank space in images, too.
+
+
+
+
+
+
+
+ ilGetData
+ ILubyte *
+ ilGetData returns an unsigned byte pointer to the current bound image's data to allow direct access and modification to the contents of the image.
+
+
+
+
+
+
+
+
+
+
+
+ ilHint
+ ILvoid
+
+
+ ilHint lets the user control aspects of OpenIL's behaviour, in order to optimize either speed, memory, compression or quality, depending wholly on what the user desires.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilIsImage
+ ILboolean
+
+ ilIsImage returns whether the image name in Image is a valid image in use. If the image name in Image is in use, ilIsImage returns IL_TRUE. If Image is 0, ilIsImage returns IL_FALSE, because the default image is a special image and is never returned by ilGenImages. If the image name has been deleted by ilDeleteImages or never generated byilGenImages, IL_FALSE is returned.
+
+
+
+
+
+
+
+ ilConvertPal
+ ILboolean
+
+ ilIsImage returns whether the image name in Image is a valid image in use. If the image name in Image is in use, ilIsImage returns IL_TRUE. If Image is 0, ilIsImage returns IL_FALSE, because the default image is a special image and is never returned by ilGenImages. If the image name has been deleted by ilDeleteImages or never generated byilGenImages, IL_FALSE is returned.
+
+
+
+
+
+
+
+
+
+
+
+ ilLoad
+ ILboolean
+
+
+ ilLoad can be used much in the same way ilLoadImage is used, except with ilLoad, it is possible to force OpenIL to load a file as a specific image format, no matter what the extension.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilLoadF
+ ILboolean
+
+
+ ilLoadF loads an image from a previously opened file
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilLoadL
+ ILboolean
+
+
+
+ ilLoadL loads an image from a memory lump
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilRegisterLoad
+ ILboolean
+
+
+ ilRegisterLoad allows the user to register functions for use by OpenIL, when loading unknown image types. The user can also override the default internal loading functions by passing their extension in Ext when using ilLoadImage. ilRegisterLoad allows the user to use their own loading functions while using OpenIL's capabilities, or to extend OpenIL when it does not support a specific image format
+
+
+
+
+
+
+
+
+
+
+ ilRegisterFormat
+ ILvoid
+
+ ilRegisterFormat tells OpenIL what format the current registered image is in. This function is to be used from within functions that have been registered via ilRegisterLoad
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilRegisterOrigin
+ ILvoid
+
+ ilRegisterFormat tells OpenIL what format the current registered image is in. This function is to be used from within functions that have been registered via ilRegisterLoad
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilRegisterPal
+ ILvoid
+
+
+
+ The ilRegisterPal function registers the current image's palette.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilRegisterType
+ ILvoid
+
+ ilRegisterType tells OpenIL what datatype the current registered image uses. This function is to be used from within functions that have been registered via ilRegisterLoad.
+
+
+
+
+
+
+
+
+ ilRegisterSave
+ ILboolean
+
+
+ ilRegisterType tells OpenIL what datatype the current registered image uses. This function is to be used from within functions that have been registered via ilRegisterLoad.
+
+
+
+
+
+
+
+
+
+
+ ilRemoveLoad
+ ILboolean
+
+ ilRemoveLoad removes a registered extension handler from the registered load functions list. Use this function when a new handler for an extension needs to be registered.
+
+
+
+
+
+
+
+ ilRemoveSave
+ ILboolean
+
+ ilRemoveSave removes a registered extension handler from the registered save functions list. Use this function when a new handler for an extension needs to be registered.
+
+
+
+
+
+
+
+ ilSavePal
+ ILboolean
+
+ If the current bound image has a palette, ilSavePal saves the current image's palette to the file specified by FileName. Currently, OpenIL only supports saving to Paint Shop Pro .pal files.
+
+
+
+
+
+
+
+
+
+
+
+
+ ilGetPalette
+ ILubyte *
+ ilGetPalette returns an unsigned byte pointer to the current bound image's palette (if one exists) to allow direct access and modification to the contents of the palette.
+
+
+
+
+
+
+
+
+
+
+ ilLoadPal
+ ILboolean
+
+ ilLoadPal simply loads a palette from the file specified by FileName into the current bound image's palette. If the current bound image is not of type IL_COLOR_INDEX, the palette is not used, but it is loaded nonetheless. ilLoadPal can load .col, Halo and Jasc PSP palette files.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSetPixels
+ ILvoid
+
+
+
+
+
+
+
+
+
+ ilCopyPixels has very simple behaviour. It simply copies a block of pixels from the Data buffer to the current image's data. XOff, YOff and ZOff can be used to skip a certain number of pixels in each respective direction. If XOff + Width, YOff + Height and/or ZOff + Depth is greater than the current image's width, height or depth, only the current image's width, height or depth number of pixels will be copied to the current image's data buffer.
+
+
+
+
+
+
+
+
+
+
+
+ ilRegisterMipNum
+ ILboolean
+
+ ilRegisterMipNum tells OpenIL the number of mipmaps the current image has. The mipmaps can then be chosen and modified via ilActiveMipmap. This function is to be used from within functions that have been registered via ilRegisterLoad.
+
+
+
+
+
+
+
+ ilRegisterNumImages
+ ILboolean
+
+ ilRegisterNumImages tells OpenIL the number of images in the current image's animation chain. The "next" images can then be chosen and modified via ilActiveImage. This function is to be used from within functions that have been registered via ilRegisterLoad.
+
+
+
+
+
+
+
+ ilActiveLayer
+ ILboolean
+
+ ilActiveLayer is not yet used.
+
+
+
+
+
+
+
+
+
+
+
+
+ ilOverlayImage
+ ILboolean
+
+
+
+
+ The ilOverlayImage function copies the image named by Src onto the current bound image. XCoord, YCoord and ZCoord are allowed to be any number, even negative numbers, for if you want to start copying Src in the middle of it to the current image's left side. If the image named by Src has alpha components, then blending will occur, instead of just a simple overlay.
+
+
+
+
+
+
+
+
+
+ ilCloneCurImage
+ ILuint
+ ilCloneCurImage creates a copy of the current image and returns the id of the new image. If a subimage of the current image is currently selected via ilActiveImage, ilActiveLayer or ilActiveMipmap, the subimage is copied, not the base image.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSetMemory
+ ILvoid
+
+
+ ilSetMemory was created to let DevIL users override the default memory allocation and deallocation functions present in DevIL. This support can be useful if you are using your own optimized memory handler or anything similar.
+
+
+
+
+
+ ilSetWrite
+ ILvoid
+
+
+
+
+
+
+ ilSetWrite allows you to override the default DevIL saving functions with your own. You are virtually unlimited in how your functions work, as long as they have the same behaviour as DevIL's default saving functions. All the functions work on the ILHANDLE type, which is a just a void pointer.
+
+
+
+
+
+
+
+ ilResetRead
+ ILvoid
+ ilResetRead resets the reading functions set by ilSetRead.
+
+
+
+
+
+
+
+ ilResetWrite
+ ILvoid
+ ilResetWrite resets the writing functions set by ilSetWrite.
+
+
+
+
+
+
+
+ ilSetDuration
+ ILboolean
+
+ ilSetDuration allows you to set how long to show the currently bound image. This function can also change the durations of individual images in animation chains.
+
+
+ ilApplyProfile
+ ILboolean
+
+
+ iluApplyProfile applies a colour profile (files with extension .icm) to the currently bound image. InProfile describes the current image's colour space, and OutProfile describes the colour space to convert the currently bound image to. If InProfile is NULL, DevIL attempts to use the colour profile present in the image, if one is present, else it returns IL_FALSE.
+
+
+
+
+
+
+
+ ilSetString
+ ILvoid
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSetString gives DevIL users the option to set strings in certain file formats that have fields for strings, making DevIL highly customizable. Choose one of the acceptable parameters for Mode and specify any string you want. If the string is too long, it will be truncated when writing to the file.
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSaveF
+ ILboolean
+
+
+ ilSaveF saves an image to a previously opened file
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSaveL
+ ILboolean
+
+
+
+ ilSaveL saves an image to a memory lump
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSave
+ ILboolean
+
+
+ ilSave can be used much in the same way ilSaveImage is used, except with ilSave, it is possible to force OpenIL to save a file as a specific image format, no matter what the extension.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilSetInteger
+ ILvoid
+
+
+ The ilSetInteger function sets the value of a selected mode. it's the ilGetInteger's counterpart
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ IL_VENDOR
+ Describes the OpenIL vendor and should be used only with ilGetString
+
+
+
+
+
+ IL_VERSION
+ Used to retrive a string describing the current OpenIL version.
+
+
+
+
+
+
+ IL_ORIGIN_SET
+ IL Mode Value. When enabled, the origin is specified at an absolute position, and all images loaded or saved adhere to this set origin. For more information, check out ilOriginFunc.
+
+
+
+
+
+
+
+
+
+
+
+
+ IL_FILE_OVERWRITE
+ IL Mode Value. If enabled while saving, OpenIL will overwrite existing files, else IL_FILE_ALREADY_EXISTS is set, and the image is not saved.
+
+
+
+
+
+
+
+
+ IL_CONV_PAL
+ IL Mode Value. When enabled, OpenIL automatically converts palette'd images to their base types, e.g. converting to a bgra image.
+
+
+
+
+
+
+
+
+
+
+
+
+ IL_ORIGIN_MODE
+ IL Mode Value. Returns the current origin position.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ IL_FILE_MODE
+ IL Mode Value. Returns whether file overwriting when saving is enabled.
+
+
+
+
+
+
+
+
+
+ IL_FORMAT_SET
+ IL Mode Value. Returns whether all images loaded are converted to a specific format.
+
+
+
+
+
+
+
+
+ IL_FORMAT_MODE
+ IL Mode Value. Returns the format images are converted to upon loading.
+
+
+
+
+
+
+
+
+ IL_TYPE_SET
+ IL Mode Value. Returns whether all images loaded are converted to a specific type.
+
+
+
+
+
+
+
+
+ IL_TYPE_MODE
+ IL Mode Value. Returns the type images are converted to upon loading.
+
+
+
+
+
+
+
+
+ IL_VERSION_NUM
+ IL Mode Value. Returns the version number of the shared library. This can be checked against the IL_VERSION #define.
+
+
+
+
+
+
+
+
+ IL_IMAGE_WIDTH
+ IL Mode Value. Returns the current image's width.
+
+
+
+
+
+
+
+
+ IL_IMAGE_HEIGHT
+ IL Mode Value. Returns the current image's height.
+
+
+
+
+
+
+
+
+ IL_IMAGE_BYTES_PER_PIXEL
+ IL Mode Value. Returns the bytes per pixel of the current image's data.
+
+
+
+
+
+
+
+
+ IL_IMAGE_BITS_PER_PIXEL
+ IL Mode Value. Returns the bits per pixel of the current image's data.
+
+
+
+
+
+
+
+
+ IL_IMAGE_FORMAT
+ IL Mode Value. Returns the current image format.
+
+
+
+
+
+
+
+
+ IL_IMAGE_TYPE
+ IL Mode Value. Returns the current images type.
+
+
+
+
+
+
+
+
+ IL_NUM_IMAGES
+ IL Mode Value. Returns the number of images in the current image animation chain.
+
+
+
+
+
+
+
+
+ IL_NUM_MIPMAPS
+ IL Mode Value. Returns the number of mipmaps of the current image.
+
+
+
+
+
+
+
+
+ IL_PALETTE_TYPE
+ IL Mode Value. Returns the palette type of the current image.
+
+
+
+
+
+
+
+
+ IL_PALETTE_BPP
+ IL Mode Value. Returns the bytes per pixel of the current images palette.
+
+
+
+
+
+
+
+
+ IL_PALETTE_NUM_COLS
+ IL Mode Value. Returns the number of colours of the current images palette.
+
+
+
+
+
+
+
+
+ IL_ACTIVE_IMAGE
+ IL Mode Value. Returns the current image number.
+
+
+
+
+
+
+
+
+ IL_ACTIVE_LAYER
+ IL Mode Value. Returns the current layer number.
+
+
+
+
+
+
+
+
+ IL_CUR_IMAGE
+ IL Mode Value. Returns the current bound image name.
+
+
+
+
+
+
+
+
+ IL_ACTIVE_MIPMAP
+ IL Mode Value. Returns the current mipmap number.
+
+
+
+
+
+
+
+
+ IL_USE_KEY_COLOUR
+ IL Mode Value. Returns whether OpenIL uses a key colour (not used yet).
+
+
+
+
+
+
+
+
+ IL_ILLEGAL_OPERATION
+ The operation attempted is not allowable in the current state. The function returns with no ill side effects. Generally there is currently no image bound or it has been deleted via ilDeleteImages. You should use ilGenImages and ilBindImage before calling the function.
+
+
+ IL_OUT_OF_MEMORY
+ Could not allocate enough memory for the image data.
+
+
+ IL_INVALID_CONVERSION
+ During a conversion destination format and/or dest type was an invalid identifier. In the function documentation there should be a more specific descriptionanation.
+
+
+ IL_INVALID_ENUM
+ An invalid value have been used, which was not part of the set of values that can be used. In the function documentation there should be a more specific descriptionanation.
+
+
+ IL_INVALID_PARAM
+ An invalid value have been used, which was not part of the set of values that can be used. In the function documentation there should be a more specific descriptionanation.
+
+
+ IL_NO_ERROR
+ No detectable error has occured.
+
+
+ IL_FORMAT_NOT_SUPPORTED
+ The format a function tried to use was not able to be used by that function.
+
+
+ IL_INTERNAL_ERROR
+ A serious error has occurred. Please e-mail an admin with the conditions leading up to this error being reported.
+
+
+ IL_INVALID_VALUE
+ An invalid value was passed to a function or was in a file.
+
+
+ IL_ILLEGAL_FILE_VALUE
+ An illegal value was found in a file trying to be loaded.
+
+
+ IL_INVALID_FILE_HEADER
+ A file's header was incorrect.
+
+
+ IL_COULD_NOT_OPEN_FILE
+ Could not open the file specified. The file may already be open by another app or may not exist.
+
+
+ IL_INVALID_EXTENSION
+ The extension of the specified filename was not correct for the type of image-loading function.
+
+
+ IL_FILE_ALREADY_EXISTS
+ The filename specified already belongs to another file. To overwrite files by default read more at ilEnable function.
+
+
+ IL_OUT_FORMAT_SAME
+ Tried to convert an image from its format to the same format.
+
+
+ IL_STACK_OVERFLOW
+ One of the internal stacks was already filled, and the user tried to add on to the full stack.
+
+
+ IL_STACK_UNDERFLOW
+ One of the internal stacks was empty, and the user tried to empty the already empty stack.
+
+
+ IL_LIB_JPEG_ERROR
+ An error occurred in the libjpeg library.
+
+
+ IL_LIB_PNG_ERROR
+ An error occurred in the libpng library.
+
+
+ IL_UNKNOWN_ERROR
+ No function sets this yet, but it is possible (not probable) it may be used in the future.
+
+
+
+ IL_ORIGIN_BIT
+ Preserves the origin state set by ilOriginFunc.
+
+
+ IL_FILE_BIT
+ Preserves whether OpenIL is allowed to overwrite files when saving (set by ilEnable, ilDisable).
+
+
+ IL_PAL_BIT
+ Preserves whether OpenIL is supposed to convert palette'd to truecolour images (set by ilEnable, ilDisable).
+
+
+ IL_ALL_ATTRIB_BITS
+ Preserves all OpenIL states and attributes.
+
+
+
+
+ iluFlipImage
+ ILboolean
+ iluFlipImage inverts an image over the x axis. The image will be upside-down after calling this function. If this function is called twice in succession, the image is restored to its original state. A version of this function in OpenIL is used throughout internally when loading images to correct images that would otherwise be upside-down. Using ilOriginFunc will essentially tell the library which way is up.
+
+
+
+
+
+
+
+
+
+
+
+ iluMirror
+ ILboolean
+ iluMirror mirrors an image across its y axis, making it appear backwards.
+
+
+
+
+
+
+
+
+
+ iluNegative
+ ILboolean
+ iluNegative creates a negative version of an image, like it was viewed as a picture negative instead of the actual picture. The effect is caused by inverting the image's colours, such as a green pixel would become purple (red-blue).
+
+
+
+
+
+
+
+
+
+ iluSwapColours
+ ILboolean
+ iluSwapColours "swaps" the colour order of the current image. If the current image is in bgr(a) format, iluSwapColours will change the image to use rgb(a) format, or vice-versa. This can be helpful when you want to manipulate the image data yourself but only want to use a certain colour order. To determine the current colour order, call ilGetInteger with the IL_IMAGE_FORMAT parameter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ iluBuildMipmaps
+ ILboolean
+ iluBuildMipmaps generates power-of-2 mipmaps for an image. If the image does not have power-of-2 dimensions, then the image is resized via iluScale. Mipmaps are then generated for the image, down to a 1x1 image. To use the mipmaps, see ilActiveMipmap.
+
+
+
+
+
+
+
+
+
+
+
+ iluInvertAlpha
+ ILboolean
+ iluInvertAlpha inverts the alpha of the currently bound image.
+
+
+
+
+
+
+
+
+
+
+ iluGetString
+ const char*
+
+ iluGetString returns a constant human-readable string describing the current OpenILU implementation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ iluErrorString
+ const ILbyte*
+
+ iluErrorString returns a human-readable string of the error in Error. This can be useful for displaying the human-readable error in your program to let the user know wtf just happened.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ iluRotate
+ ILboolean
+
+ iluRotate simply rotates an image about the center by Angle degrees. The background where there is space left by the rotation will be set to the clear colour.
+
+
+
+
+
+
+
+
+
+
+ iluAlienify
+ ILboolean
+ The story behind this function is actually sorta funny. I had been using a picture of me (contact me if you want it! =) as a test image, and I started working on some colour matrix filters. Well, my first attempt screwed-up, because I had changed the equations to accomodate my bgr image, but I transposed the equations entirely wrong. I got a really neat output, though, where I looked like an alien. =) I decided to keep the screw-up and placed it in iluAlienify. I can't say I've ever run across a filter like this before.
+
+
+
+
+
+
+
+
+
+ iluScale
+ ILboolean
+
+
+
+ The iluScale function scales the image to the new dimensions specified, shrinking or enlarging the image, depending on the image's original dimensions. There are different filters that can be used to scale an image, and which filter to use can be specified via iluImageParameter.
+
+
+
+
+
+
+
+
+
+
+ iluBlurAvg
+ ILboolean
+
+ iluBlurAvg blurs an image using an averaging convolution filter. The filter is applied up to Iter number of times, giving more of a blurring effect the higher Iter is. The 3x3 convolution filter used to do the average blur is: %center% %img:../images/matrix_avg.gif% %center/%
+
+
+
+
+
+
+
+
+
+
+ iluBlurGaussian
+ ILboolean
+
+ iluBlurGaussian blurs an image using a Gaussian convolution filter, which usually gives better results than the filter used by iluBlurAvg. The filter is applied up to Iter number of times, giving more of a blurring effect the higher Iter is.
+
+
+
+
+
+
+
+
+
+
+
+ iluContrast
+ ILboolean
+
+ iluContrast changes the contrast of an image by using interpolation and extrapolation. Common values for Contrast are in the range -0.5 to 1.7. Anything below 0.0 generates a negative of the image with varying contrast. 1.0 outputs the original image. 0.0 - 1.0 lowers the contrast of the image. 1.0 - 1.7 increases the contrast of the image. This effect is caused by interpolating (or extrapolating) the source image with a totally grey image.
+
+
+
+
+
+
+
+
+
+ iluCrop
+ ILboolean
+
+
+
+
+
+
+ iluCrop "crops" the current image to new dimensions. The new image appears the same as the original, but portions of the image are clipped-off, depending on the values of the parameters of these functions. If XOff + Width, YOff + Height or ZOff + Depth is larger than the current image's dimensions, ILU_ILLEGAL_OPERATION is set. If ZOff is minus or equal to one the crop will be done only on 2 dimensions
+
+
+
+
+
+
+
+
+
+
+ iluEdgeDetectP
+ ILboolean
+ iluEdgeDetectP detects the edges in the current image by combining two convolution filters. The filters used are Prewitt filters.
+
+
+
+
+
+
+
+
+
+
+
+ iluEdgeDetectS
+ ILboolean
+ iluEdgeDetectS detects the edges in the current image by combining two convolution filters. The filters used are Sobel filters.
+
+
+
+
+
+
+
+
+
+
+
+ iluEnlargeCanvas
+ ILboolean
+
+
+
+ iluEnlargeCanvas enlarges the canvas of the current image, clearing the background to the colour specified in ilClearColour. To control the placement of the image, use iluImageParameter
+
+
+
+
+
+
+
+
+
+
+
+
+ iluGammaCorrectInter
+ ILboolean
+
+ iluGammaCorrectInter adjust the gamma of the current image. If Gamma is less than 1.0, the image is darkened. If Gamma is greater than 1.0, the image is brightened. It uses interpolation so it's slower then iluGammaCorrectScale
+
+
+
+
+
+
+
+
+
+
+
+ iluGammaCorrectScale
+ ILboolean
+
+ These two functions adjust the gamma of the current image. If Gamma is less than 1.0, the image is darkened. If Gamma is greater than 1.0, the image is brightened. iluGammaCorrectInter is a slower function and uses interpolation to achieve this effect. iluGammaCorrectScale achieves this effect by scaling the colours via iluScaleColours.
+
+
+
+
+
+
+
+
+
+
+
+ iluPixelize
+ ILboolean
+
+ iluPixelize performs the effect that can be seen on television, where people want their identity to remain anonymous, so the editors cover the person's face with a very blocky pixelized version. PixSize specifies how blocky the image should be, with 1 being the lowest blockiness (doesn't change the image).
+
+
+
+
+
+
+
+
+
+ iluSaturate1f
+ ILboolean
+
+ iluSaturate1f applies a saturation consistent with the IL_LUMINANCE conversion values to red, green and blue.
+
+
+
+
+
+
+
+
+
+
+ iluSaturate4f
+ ILboolean
+
+
+
+ iluSaturate1f applies a saturation consistent with the IL_LUMINANCE conversion values to red, green and blue.
+
+
+
+
+
+
+
+
+
+
+ iluSharpen
+ ILboolean
+
+
+ iluSharpen can actually either sharpen or blur an image, depending on the value of Factor. iluBlurAvg and iluBlurGaussian are much faster for blurring, though. When Factor is 1.0, the image goes unchanged. When Factor is in the range 0.0 - 1.0, the current image is blurred. When Factor is in the range 1.0 - 2.5, the current image is sharpened. To achieve a more pronounced sharpening/blurring effect, simply increase the number of iterations by increasing the value passed in Iter.
+
+
+
+
+
+
+
+
+
+
+
+ iluCompareImage
+ ILboolean
+
+ iluCompareImage compares the current image to the image having the name in Comp. If both images are identical, IL_TRUE is returned. IL_FALSE is returned if the images are not identical. The bound image before calling this function remains the bound image after calling ilCompareImage.
+
+
+
+
+
+
+
+
+
+ iluGetInteger
+ ILint
+
+ The iluGetInteger function returns the value of a selected mode
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ iluGetIntegerv
+ ILvoid
+
+
+ The iluGetIntegerv function returns the mode value in the Param parameter.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ iluSaturate4f
+ ILboolean
+
+
+
+ iluScaleColours scales the individual colour components of the current bound image. Using 1.0f as any of the parameters yields that colour component's original plane in the new image.
+
+
+
+
+
+
+
+
+
+
+ iluColoursUsed
+ ILboolean
+ iluColoursUsed creates a copy of the image data, quicksorts it and counts the number of unique colours in the image. This value is returned without affecting the original image.
+
+
+
+
+
+
+
+
+
+
+ iluImageParameter
+ ILvoid
+
+
+ iluImageParameter modifies the behaviour of some ilu functions. Right now, it controls the behaviour of iluEnlargeCanvas and iluScale. For ILU_FILTER, values for Param other than ILU_NEAREST, ILU_LINEAR and ILU_BILINEAR are higher-quality scaling filters and take longer to perform.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ iluInit
+ ILvoid
+ iluInit starts ILU and must be called prior to using ILU
+
+
+
+
+
+
+ iluEmboss
+ ILboolean
+ iluEmboss embosses an image, causing it to have a "relief" feel to it using a convolution filter:
+
+
+
+
+
+
+
+
+
+
+ iluNoisify
+ ILboolean
+
+ iluNoisify adds Factor amount of random noise to an image. Factor can range from 0.0f to 1.0f, with 1.0 being extreme noise and 0.0 being no noise
+
+
+
+
+
+
+
+
+
+ iluNoisify
+ ILboolean
+
+
+
+ iluEnlargeImage enlarges an image's dimensions by multipliers, via iluScale. This function could be useful if you wanted to double the size of all images or something similar
+
+
+
+
+
+
+
+
+
+
+ iluNoisify
+ ILboolean
+
+
+
+ iluEnlargeImage enlarges an image's dimensions by multipliers, via iluScale. This function could be useful if you wanted to double the size of all images or something similar
+
+
+
+
+
+
+
+
+
+
+ iluDeleteImage
+ ILvoid
+
+ iluDeleteImage is a convenience function to delete a single image instead of calling ilDeleteImages. Deprecated! use ilDeleteImage instead
+
+
+
+
+
+
+
+
+
+
+
+
+ iluGenImage
+ ILvoid
+
+ iluGenImage is a convenience function to delete a single image instead of calling ilGenImages. Deprecated! use ilGenImage instead
+
+
+
+
+
+
+
+
+
+
+
+ iluGetImageInfo
+ ILvoid
+ The iluGetImageInfo function retrieves information about the current image in an ILinfo struct. This is useful when you are repeatedly calling ilGetInteger and is more efficient in this case.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ILU_INVALID_PARAM
+ A Parameter was invalid or out of range
+
+
+ ILU_INVALID_ENUM
+ A Parameter was invalid or out of range
+
+
+ ILU_OUT_OF_MEMORY
+ Could not allocate enough memory in an operation
+
+
+ ILU_INTERNAL_ERROR
+ A serious error has occurred. Please e-mail an admin with the conditions leading up to this error being reported.
+
+
+ ILU_INVALID_VALUE
+ An invalid value was passed to a function or was in a file
+
+
+ ILU_ILLEGAL_OPERATION
+ The operation attempted is not allowable in the current state. The function returns with no ill side effects. Generally there is currently no image bound or it has been deleted via ilDeleteImages. You should use ilGenImages and ilBindImage before calling the function.
+
+
+
+
+
+ ilutIsEnabled
+ ILboolean
+ ilutIsEnabled returns whether the mode indicated by Mode is enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutIsDisabled
+ ILboolean
+ ilutIsDisabled returns whether the mode indicated by Mode is disabled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutGetHPal
+ HPALETTE
+ The ilutGetHPal function returns a Windows-friendly palette. If the current bound image has a palette, ilutGetHPal returns a Windows-compatible copy of the current image's palette in HPAL format.
+
+
+
+
+
+
+
+
+
+
+
+ ilutInit
+ ILvoid
+ The ilutInit function initializes ILUT.
+
+
+
+
+
+
+ ilutGLBindTexImage
+ GLuint
+ The ilutGLBindTexImage function binds an image to a generated OpenGL texture.
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutGLTexImage
+ ILboolean
+ The ilutGLTexImage function binds an image to an OpenGL texture, simply calls glTexImage2D with the current bound image's data and attributes.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutGLBindMipmaps
+ GLuint
+ The ilutGLBindMipmaps function binds an image to an OpenGL texture and creates mipmaps, generates a texture via glGenTextures, binds the current OpenIL image to it, generates mipmaps via gluBuild2DMipmaps and returns the texture name. This function is a more general purpose version of ilutOglBindTexImage.
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutGLScreen
+ ILboolean
+ ilutGLScreen copies the current OpenGL window contents to the current bound image, effectively taking a screenshot. The new image attributes are that of the current OpenGL window's.
+
+
+
+
+
+
+
+
+
+
+
+ ilutGLScreenie
+ ILboolean
+ ilutGLScreen copies the current OpenGL window contents to a temporary image, effectively taking a screenshot. The screenshot image is then saved to disk as screen0.tga - screen127.tga (the lowest name it can find). This is just a convenience function that uses ilutGLScreen.
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutGetWinClipboard
+ ILboolean
+ ilutGetWinClipboard copies the contents of the Windows clipboard to the current bound image, resizing as necessary.
+
+
+
+
+
+
+
+
+
+
+ ilutSetWinClipboard
+ ILboolean
+ ilutSetWinClipboard copies the current bound image to the Windows clipboard.
+
+
+
+
+
+
+
+
+
+
+ ilutPopAttrib
+ ILvoid
+ ilutPopAttrib pops the last pushed stack entry off the stack and copies the bits specified when pushed by ilutPushAttrib to the previous set of states.
+
+
+
+
+
+
+
+
+ ilutGetBmpInfo
+ ILvoid
+
+ ilutGetBmpInfo fills a BITMAPINFO struct with the current image's information. The BITMAPINFO struct is used commonly used in Windows applications.
+
+
+
+
+
+
+
+
+
+ ilutGetPaddedData
+ ILvoid
+ ilutGetPaddedData gets a copy of the current image's data, but pads it to be DWORD-aligned, just how Windows likes it. Almost all Windows functions that use images expect the images to be DWORD-aligned. The caller is responsible for freeing the memory returned by ilutGetPaddedData.
+
+
+
+
+
+
+
+
+
+ ilutSetHPal
+ ILboolean
+
+ ilutSetHPal sets the current iamge's palette from a logical Windows palette handle specified in Pal. If the current image is not colour-indexed, the palette is still loaded, though it will never be used.
+
+
+
+
+
+
+
+
+
+ ilutLoadResource
+ ILboolean
+
+
+
+
+ ilutLoadResource is a Windows-specific function that loads a resource as the current bound image. This feature allows you to have images directly in your .exe and not worry whether a particular file is present on the user's harddrive. An alternative, more portable solution is to use ilSave with IL_CHEAD as the Type parameter.
+
+
+
+
+
+
+
+
+
+
+
+ ilutGLLoadImage
+ GLuint
+
+ ilutGLLoadImage loads an image directly to an OpenGL texture, skipping the use of OpenIL image names.
+
+
+
+
+
+
+ ilutWinLoadImage
+ HBITMAP
+
+
+ ilutWinLoadImage loads an image directly to a Win32 HBITMAP, skipping the use of OpenIL image names.
+
+
+
+
+
+
+
+ ilutSetHBitmap
+ HBITMAP
+
+ ilutSetHBitmap copies Bitmap to the current bound image in a format OpenIL can understand. The image can then be used just as if you had loaded an image via ilLoadImage. This function is the opposite of ilutConvertToHBitmap.
+
+
+
+
+
+
+
+ ilutWinSaveImage
+ Ilboolean
+
+
+ ilutWinSaveImage saves Bitmap to FileName. This function is the complement of ilutWinLoadImage.
+
+
+
+
+
+
+ ilutGetBoolean
+ ILboolean
+
+
+ The ilutGetBooleanv return the value of a selected mode.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutGetInteger
+ ILint
+
+
+ The ilutGetIntegerv return the value of a selected mode.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutGetBooleanv
+ ILvoid
+
+ The ilutGetBoolean return the value of a selected mode.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutGetInteger
+ ILint
+
+ The ilutGetInteger return the value of a selected mode.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ilutConvertToHBitmap
+ HBITMAP
+
+ ilutConvertToHBitmap creates a Windows bitmap handle (HBITMAP) copy of the current image, for direct use in Windows.
+
+
+
+
+
+
+
+
+
+
+
+ ilutGLBuildMipmaps
+ ILboolean
+ ilutGLBuildMipmaps generates mipmaps via gluBuild2DMipmaps from an image. This function is similar to ilutGLTexImage but creates mipmaps.
+
+
+
+
+
+
+
+
+
+
+ ilutD3D8MipFunc
+ ILvoid
+
+ ilutD3D8MipFunc changes the number of miplevels specified whenever creating a Direct3D 8 texture. The default value is 0, which means that all mipmap levels are created.
+
+
+ ilutD3D8VolTexFromFile
+ IDirect3DTexture8 *
+
+
+
+ ilutD3D8VolTexFromFile loads the file named by FileName and converts it to a Direct3D 8 volume texture (IDirect3DVolumeTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFile but for a volume texture.
+
+
+
+
+
+
+
+
+
+ ilutD3D8VolumeTexture
+ IDirect3DTexture8 *
+
+ The ilutD3D8VolumeTexture function creates a Direct3D 8 texture (IDirect3DVolumeTexture8) from the current bound image.
+
+
+
+
+
+
+
+
+ ilutD3D8TexFromFileInMemory
+ ILboolean
+
+
+
+
+ ilutD3D8TexFromFileInMemory loads the file present in Lump and converts it to a Direct3D 8 texture (IDirect3DTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFileInMemory.
+
+
+
+
+
+
+
+
+ ilutD3D8VolTexFromFileInMemory
+ ILboolean
+
+
+
+
+ ilutD3D8VolTexFromFileInMemory loads the file present in Lump and converts it to a Direct3D 8 volume texture (IDirect3DVolumeTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFileInMemory but for a volume texture.
+
+
+
+
+
+
+
+
+ ilutD3D8TexFromFileHandle
+ ILboolean
+
+
+
+ ilutD3D8TexFromFileInMemory loads the file present in Lump and converts it to a Direct3D 8 texture (IDirect3DTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFile but with a file handle.
+
+
+
+
+
+ ilutD3D8VolTexFromFileHandle
+ ILboolean
+
+
+
+ ilutD3D8VolTexFromFileHandle loads the file present in File and converts it to a Direct3D 8 volume texture (IDirect3DVolumeTexture8). This function creates the texture, so the pointer does not even have to be allocated beforehand. This function is functionally equivalent to D3DX's D3DXCreateTextureFromFile but with a file handle and a volume texture.
+
+
+
+
+
+ ILUT_PALETTE_MODE
+ An ILUT mode not used right now
+
+
+
+
+
+
+
+
+ ILUT_OPENGL_CONV
+ An ILUT mode used to track if OpenIL is allowed to use GL_RGB8 and GL_RGBA8 instead of GL_RGB8 or GL_RGBA8 (useful with nVidia cards)
+
+
+
+
+
+
+
+
+ ILUT_VERSION_NUM
+ Returns the version number of the shared library. This can be checked against the ILUT_VERSION #define
+
+
+ ILUT_PALETTE_MODE
+ Whether ilut uses palettes or converts the image to truecolour before sending it to the renderer.
+
+
+ ILUT_OPENGL_CONV
+ Whether to use GL_RGB8 or GL_RGB, etc. when passing data to OpenGL only.
+
+
+ ILUT_INVALID_ENUM
+ An invalid parameter was passed to a function, probably a wrong constant or an out of range value.
+
+
+ ILUT_ILLEGAL_OPERATION
+ The operation attempted is not allowable in the current state. The function returns with no ill side effects.
+
+
+ ILUT_INVALID_PARAM
+ An invalid parameter was passed to a function, such as a NULL pointer.
+
+
+ ILUT_INVALID_ENUM
+ An unacceptable enumerated value was passed to a function.
+
+
+ ILUT_OUT_OF_MEMORY
+ Could not allocate enough memory in an operation.
+
+
+ ILUT_INVALID_VALUE
+ An invalid value was passed to a function or was in a file.
+
+
+ ILUT_NOT_SUPPORTED
+ A type is valid but not supported in the current build.
+
+
+ ILUT_COULD_NOT_OPEN_FILE
+ Could not open the file specified. The file may already be open by another app or may not exist.
+
+
+ ILUT_STACK_UNDERFLOW
+ One of the internal stacks was empty, and the user tried to empty the already empty stack.
+
+
+ ILUT_STACK_OVERFLOW
+ One of the internal stacks was already filled, and the user tried to add on to the full stack.
+
+
+
+
+
+ Data Formats
+ This is a list of all the constants that indicates a particular image format
+
+
+
+
+
+
+
+
+
+
+
+ Data Types
+ This is a list of all the constants that indicates a particular image data type
+
+
+
+
+
+
+
+
+
+
+
+
+ Palette Types
+ This is a list of all the constants that indicates a particular palette color data type
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hint Targets
+ An enum indicating what behaviour of the library is to be controlled.
+
+
+
+
+
+
+
+
+
+ Hint Modes
+ The desired behaviour of some specific situation
+
+
+
+
+
+
+
+
+
+ Image Formats
+ A List of all the image formats
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/DevIL-docs/DocBuilder.java b/DevIL-docs/DocBuilder.java
new file mode 100644
index 00000000..b942b9da
--- /dev/null
+++ b/DevIL-docs/DocBuilder.java
@@ -0,0 +1,686 @@
+import java.io.*;
+import javax.xml.parsers.*;
+import java.util.Vector;
+import java.util.Stack;
+import java.util.Enumeration;
+import org.xml.sax.*;
+import org.xml.sax.helpers.*;
+
+public class DocBuilder extends DefaultHandler {
+ private String content = null;
+ public int flag = 0;
+
+ private PrintStream out = null;
+ private Stack xml_trace = new Stack();
+ private int entity_type;
+ private int content_type = 0;
+ private Entity container;
+ private Vector sets = new Vector();
+ private Set current_set;
+
+ private Links current_link;
+
+ class NamedObject {
+ String name = null;
+ }
+
+ class Entity extends NamedObject {
+ String description = null;
+ }
+
+ class LinkedEntity extends Entity {
+ Vector links = new Vector();
+ //links
+ };
+
+ class Value extends LinkedEntity {
+ };
+
+ class Function extends LinkedEntity {
+ String ret = null;
+ Vector param = new Vector();
+ };
+
+ class Param extends Entity {
+ String type = null;
+ }
+
+ class Link extends NamedObject {
+ String from;
+ String description;
+ };
+
+ class Links extends NamedObject {
+ Vector links = new Vector();
+ String verbose;
+ };
+
+ class Set extends NamedObject {
+ Vector entity = new Vector();
+ };
+
+ public void startElement(String uri, String localName, String rawName, Attributes attributes) {
+ xml_trace.push(new String(rawName));
+ switch (flag) {
+ case 0://DOC
+ if (rawName.compareToIgnoreCase("doc") == 0)
+ flag = 1;
+ else {
+ System.out.println("[Parser] Parse Error\nf:" + flag);
+ printXMLTrace();
+ System.exit(0);
+ }
+ break;
+ case 1://SET
+ if (rawName.compareToIgnoreCase("set") == 0) {
+ flag = 2;
+ } else {
+ System.out.println("[Parser] Parse Error\nf:" + flag);
+ printXMLTrace();
+ System.exit(0);
+ }
+
+ String set_name = getNamedAttribute("name", attributes);
+ //System.out.println("Parsing set:"+set_name);
+ current_set = new Set();
+ current_set.name = set_name;
+ sets.add(current_set);
+ break;
+ case 2:
+ if (rawName.compareToIgnoreCase("entity") == 0) {
+ flag = 3;
+ } else {
+ System.out.println("[Parser] Parse Error\nf:" + flag);
+ printXMLTrace();
+ System.exit(0);
+ }
+
+ String type = getNamedAttribute("type", attributes);
+
+ if( type.compareToIgnoreCase("value") == 0) {
+ entity_type = 0;
+ container = new Value();
+ //System.out.println("Parsing value");
+ } else if (type.compareToIgnoreCase("function") == 0) {
+ entity_type = 1;
+ container = new Function();
+ //System.out.println("Parsing func");
+ } else {
+ System.out.println("[Parser] Parse Error\nExpected a valid type, found:" + type);
+ printXMLTrace();
+ System.exit(0);
+ }
+ break;
+ case 3:
+ flag=10;
+ if (entity_type == 0) {
+ if (rawName.compareToIgnoreCase("name") == 0) {
+ content_type = 1;
+ break;
+ } else if (rawName.compareToIgnoreCase("description") == 0) {
+ content_type = 2;
+ break;
+ } else if (rawName.compareToIgnoreCase("link") == 0) {
+ current_link = new Links();
+ current_link.name = getNamedAttribute("name", attributes);
+ current_link.verbose = getNamedAttribute("verbose", attributes);
+
+ ((Value) container).links.add(current_link);
+ content_type = 4;
+ flag = 4;
+ } else {
+ flag = 3;
+ System.out.println("[Parser] Parse Error\nf:" + flag + "\nUnexpected Tag " + rawName);
+ printXMLTrace();
+ System.exit(0);
+ }
+ } else {
+ if (rawName.compareToIgnoreCase("name") == 0) {
+ content_type = 1;
+ } else if (rawName.compareToIgnoreCase("return") == 0) {
+ content_type = 2;
+ } else if (rawName.compareToIgnoreCase("description") == 0) {
+ content_type = 3;
+ } else if (rawName.compareToIgnoreCase("link") == 0) {
+ current_link = new Links();
+ current_link.name = getNamedAttribute("name", attributes);
+ current_link.verbose = getNamedAttribute("verbose", attributes);
+ ((Function) container).links.add(current_link);
+ content_type = 4;
+ flag = 4;
+ } else if (rawName.compareToIgnoreCase("param") == 0) {
+ Param p = new Param();
+ p.name = getNamedAttribute("name", attributes);
+ p.description = getNamedAttribute("description", attributes);
+ p.type = getNamedAttribute("type", attributes);
+ ((Function) container).param.add(p);
+ } else {
+ System.out.println("[Parser] Parse Error\nflag:" + flag + "\nUnexpected Tag " + rawName);
+ printXMLTrace();
+ System.exit(0);
+ }
+ }
+ break;
+ case 4:
+ if (rawName.compareToIgnoreCase("a") == 0) {
+ Link l = new Link();
+ l.name = getNamedAttribute("name", attributes);
+ l.from = getNamedAttribute("from", attributes);
+ l.description = getNamedAttribute("description", attributes);
+ current_link.links.add(l);
+ break;
+ }
+ System.out.println("[Parser] Parse Error\nflag:" + flag + "\nUnexpected Tag " + rawName);
+ printXMLTrace();
+ System.exit(0);
+ break;
+ default:
+ System.out.println("[Parser] Unexpected Internal Value. flag:" + flag);
+ printXMLTrace();
+ System.exit(0);
+ break;
+ }
+ }
+
+ public void characters(char[] ch, int start, int length) throws SAXException {
+ if (flag != 10)
+ return;
+
+ content = new String(ch, start, length);
+
+ if (entity_type == 0) {
+ Value value = (Value) container;
+ switch (content_type) {
+ case 1:
+ value.name = content;
+ // System.out.println("name:"+value.name);
+ break;
+ case 2:
+ value.description = content;
+ break;
+ default:
+ System.out.println("[Parser] Unexpected Internal Value. flag:" + flag + " at characters as entity_type:" + entity_type + " content:" + content_type);
+ printXMLTrace();
+ System.exit(0);
+ break;
+ }
+ } else {
+ Function func = (Function) container;
+ switch (content_type) {
+ case 1:
+ func.name = content;
+ // System.out.println("name:"+func.name);
+ break;
+ case 2:
+ func.ret = content;
+ break;
+ case 3:
+ func.description = content;
+ break;
+ case 4:
+ current_link.name = content;
+ flag = 4;
+ break;
+ default:
+ System.out.println("[Parser] Unexpected Internal Value. flag:" + flag + " at characters as entity_type:" + entity_type + " content:" + content_type);
+ printXMLTrace();
+ System.exit(0);
+ }
+ }
+ }
+
+ public void endElement(String uri, String localName, String rawName) {
+ String str = (String) xml_trace.pop();
+
+ if (str.compareToIgnoreCase(rawName) != 0) {
+ System.out.println("[Parser] Wrong Closing Tag, expected: " + str);
+ printXMLTrace();
+ System.exit(0);
+ }
+ switch (flag) {
+ case 3:
+ current_set.entity.add(container);
+ break;
+ case 10:
+ flag = 3;
+ break;
+ }
+ switch (flag) {
+ case 4:
+ if (rawName.compareToIgnoreCase("link") == 0)
+ flag = 3;
+ break;
+ case 3:
+ if (rawName.compareToIgnoreCase("entity") == 0)
+ flag = 2;
+ break;
+ case 2:
+ flag = 1;
+ break;
+ }
+ }
+
+ public void startDocument() {
+ System.out.println("[Parser] Document Parsing Started");
+ }
+
+ public void endDocument() {
+ System.out.println("[Parser] Documentation Parsing Completed");
+ }
+
+ public static void main(String[] args) {
+ DocBuilder doc = null;
+ try {
+ doc = new DocBuilder();
+
+ System.out.println("[System] Parse");
+ System.out.println("[Parser] Parsing DevilDoc.xml");
+ try {
+ SAXParserFactory factory = SAXParserFactory.newInstance();
+ factory.setValidating(false);
+ factory.newSAXParser().parse(new File("DevilDoc.xml"), doc);
+ } catch(Exception ex) {
+ System.out.println("[Error] Cannot Parse DevilDoc.xml");
+ System.out.println(ex);
+ }
+
+ System.out.println();
+ System.out.println("[System] Create Documentation");
+
+ doc.work();
+
+ System.out.println();
+ System.out.println("[System] Create Completed");
+ System.out.println("[System] Goodbye");
+ } catch(java.lang.StackOverflowError stack) {
+ doc.printXMLTrace();
+ System.out.println("flag:" + doc.flag);
+ }
+ }
+
+ public final void printXMLTrace() {
+ Object obj;
+ try {
+ while (true) {
+ obj = xml_trace.pop();
+ System.out.println(obj);
+ }
+ } catch(Exception e) {
+ }
+ }
+
+ private final String getNamedAttribute(String name, Attributes attr) {
+ int max = attr.getLength();
+ String str;
+ for (int ctr = 0; ctr < max; ctr++) {
+ if (attr.getQName(ctr).compareToIgnoreCase(name) == 0) {
+ return attr.getValue(ctr);
+ }
+ }
+
+ return null;
+ }
+
+ public final void work() {
+ int max_sets_ctr = sets.size();
+ for (int sets_ctr = 0; sets_ctr < max_sets_ctr; sets_ctr++) {
+ current_set = ((Set) sets.get(sets_ctr));
+ System.out.println();
+ System.out.println("[Build] Creating Set " + current_set.name);
+ try {
+ File set_dir = new File(current_set.name);
+ set_dir.mkdir();
+ } catch(Exception e) {
+ System.out.println("[Error] Can't create folder for set " + current_set.name);
+ }
+
+ int max_entity_ctr = current_set.entity.size();
+ Object ovector[] = current_set.entity.toArray();
+ Entity vector[] = new Entity[ovector.length];
+ System.arraycopy(ovector, 0, vector, 0, ovector.length);
+
+ sort(vector, vector.length - 1);
+
+ for (int entity_ctr = 0; entity_ctr < max_entity_ctr; entity_ctr++) {
+ ByteArrayOutputStream data_out = new ByteArrayOutputStream();
+ Entity e = vector[entity_ctr];
+ String file = current_set.name + "/" + e.name + ".html";
+ String data = null;
+ System.out.println("[Build] Creating " + e.name);
+ try {
+ PrintStream out = new PrintStream(new BufferedOutputStream(data_out));
+ printHeader(out, e.name);
+ out.println("
![](\"images/DevIL.gif\")
![](\"../images/DevIL.gif\")