Tao.DevIl SDK Documentation

Il Members

Il overview

Public Static (Shared) Fields

IL_3DC
IL_ACTIVE_IMAGE Returns the current image number.
IL_ACTIVE_LAYER Returns the current layer number.
IL_ACTIVE_MIPMAP Returns the current mipmap number.
IL_ALL_ATTRIB_BITS Preserves all OpenIL states and attributes.
IL_ATI1N
IL_BAD_DIMENSIONS
IL_BGR
IL_BGRA
IL_BMP Microsoft bitmap .
IL_BMP_RLE
IL_BYTE
IL_CHEAD C Header.
IL_CHEAD_HEADER_STRING
IL_COLOR_INDEX
IL_COLOUR_INDEX
IL_COMPRESS_BIT
IL_COMPRESS_LZO
IL_COMPRESS_MODE
IL_COMPRESS_NONE
IL_COMPRESS_RLE
IL_COMPRESS_ZLIB
IL_COMPRESSION_HINT Controls whether compression is used when saving images.
IL_CONV_PAL d images to their base types, e.g. converting to a bgra image.
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_CUBEMAP_NEGATIVEX
IL_CUBEMAP_NEGATIVEY
IL_CUBEMAP_NEGATIVEZ
IL_CUBEMAP_POSITIVEX
IL_CUBEMAP_POSITIVEY
IL_CUBEMAP_POSITIVEZ
IL_CUR_IMAGE Returns the current bound image name.
IL_CUT Dr. Halo .cut image.
IL_DCX .dcx image.
IL_DDS DirectDraw Surface image.
IL_DEFAULT_ON_FAIL
IL_DONT_CARE The client does not have a preference.
IL_DOOM Doom texture.
IL_DOOM_FLAT Doom flat (floor).
IL_DOUBLE
IL_DXT_NO_COMP
IL_DXT1
IL_DXT2
IL_DXT3
IL_DXT4
IL_DXT5
IL_DXTC_DATA_FORMAT
IL_DXTC_FORMAT
IL_EOF
IL_EXIF
IL_FALSE
IL_FASTEST Makes the target use a faster but more memory-intensive algorithm.
IL_FILE_ALREADY_EXISTS The filename specified already belongs to another file. To overwrite files by default read more at ilEnable function.
IL_FILE_BIT Preserves whether OpenIL is allowed to overwrite files when saving (set by ilEnable, ilDisable).
IL_FILE_MODE Returns whether file overwriting when saving is enabled.
IL_FILE_OVERWRITE
IL_FILE_READ_ERROR
IL_FILE_WRITE_ERROR
IL_FLOAT
IL_FORMAT_BIT
IL_FORMAT_MODE
IL_FORMAT_NOT_SUPPORTED The format a function tried to use was not able to be used by that function.
IL_FORMAT_SET Returns whether all images loaded are converted to a specific format.
IL_FORMAT_SPECIFIC_BIT
IL_GIF Graphics Interchange Format file.
IL_HDR RADIANCE High Dynamic Range Image.
IL_ICO Microsoft icon (.ico).
IL_ILLEGAL_FILE_VALUE An illegal value was found in a file trying to be loaded.
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_IMAGE_BITS_PER_PIXEL s data.
IL_IMAGE_BPC
IL_IMAGE_BPP
IL_IMAGE_BYTES_PER_PIXEL s data.
IL_IMAGE_CHANNELS
IL_IMAGE_CUBEFLAGS
IL_IMAGE_DEPTH
IL_IMAGE_DURATION
IL_IMAGE_FORMAT Returns the current image format.
IL_IMAGE_HEIGHT s height.
IL_IMAGE_OFFX
IL_IMAGE_OFFY
IL_IMAGE_ORIGIN
IL_IMAGE_PLANESIZE
IL_IMAGE_SIZE_OF_DATA
IL_IMAGE_TYPE Returns the current images type.
IL_IMAGE_WIDTH s width.
IL_INT
IL_INTERLACE_MODE
IL_INTERNAL_ERROR A serious error has occurred.
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_EXTENSION The extension of the specified filename was not correct for the type of image-loading function.
IL_INVALID_FILE_HEADER s header was incorrect.
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_INVALID_VALUE An invalid value was passed to a function or was in a file.
IL_JASC_PAL Load the file into the current image's palette as a Paint Shop Pro (Jasc) palette.
IL_JFIF
IL_JNG
IL_JPG Jpeg.
IL_JPG_QUALITY
IL_JPG_SAVE_FORMAT
IL_KEEP_DXTC_DATA
IL_LBM
IL_LESS_MEM Makes the target use less memory but a potentially slower algorithm.
IL_LIB_GIF_ERROR
IL_LIB_JPEG_ERROR An error occurred in the libjpeg library.
IL_LIB_MNG_ERROR
IL_LIB_PNG_ERROR An error occurred in the libpng library.
IL_LIB_TIFF_ERROR
IL_LIF Homeworld image.
IL_LOAD_EXT
IL_LOADFAIL_BIT
IL_LUMINANCE
IL_LUMINANCE_ALPHA
IL_MAX_QUANT_INDEXS
IL_MDL Half-Life model file (.mdl).
IL_MEM_SPEED_HINT Controls the memory used vs. speed tradeoff.
IL_MNG Load a Multiple Network Graphics (.mng).
IL_NEU_QUANT
IL_NEU_QUANT_SAMPLE
IL_NO_COMPRESSION Specifies that OpenIL should never use compression when saving.
IL_NO_ERROR No detectable error has occured.
IL_NUM_IMAGES Returns the number of images in the current image animation chain.
IL_NUM_LAYERS /
IL_NUM_MIPMAPS Returns the number of mipmaps of the current image.
IL_ORIGIN_BIT Preserves the origin state set by ilOriginFunc.
IL_ORIGIN_LOWER_LEFT
IL_ORIGIN_MODE Returns the current origin position.
IL_ORIGIN_SET nabled, 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_ORIGIN_UPPER_LEFT
IL_OUT_FORMAT_SAME Tried to convert an image from its format to the same format.
IL_OUT_OF_MEMORY Could not allocate enough memory for the image data.
IL_PAL_BGR24
IL_PAL_BGR32
IL_PAL_BGRA32
IL_PAL_BIT d to truecolour images (set by ilEnable, ilDisable).
IL_PAL_NONE
IL_PAL_RGB24
IL_PAL_RGB32
IL_PAL_RGBA32
IL_PALETTE_BASE_TYPE
IL_PALETTE_BPP Returns the bytes per pixel of the current images palette.
IL_PALETTE_NUM_COLS Returns the number of colours of the current images palette.
IL_PALETTE_SIZE
IL_PALETTE_TYPE Returns the palette type of the current image.
IL_PCD Kodak PhotoCD image.
IL_PCD_PICNUM
IL_PCX .pcx Image.
IL_PIC Softimage Pic image.
IL_PIX Alias | Wavefront .pix file.
IL_PNG Portable Network Graphics (.png) image.
IL_PNG_ALPHA_INDEX
IL_PNG_AUTHNAME_STRING
IL_PNG_DESCRIPTION_STRING
IL_PNG_INTERLACE
IL_PNG_TITLE_STRING
IL_PNM Portable AnyMap (.pbm, .pgm or .ppm).
IL_PSD PhotoShop (.psd) file.
IL_PSP Paint Shop Pro file.
IL_PXR Pxrar (.pxr) file.
IL_QUANTIZATION_MODE
IL_RAW Raw data with a 13-byte header.
IL_RGB
IL_RGBA
IL_RXGB
IL_SAVE_EXT
IL_SAVE_INTERLACED /
IL_SEEK_CUR
IL_SEEK_END
IL_SEEK_SET
IL_SGI SGI (.bw, .rgb, .rgba or .sgi).
IL_SGI_RLE
IL_SHORT
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_SUB_LAYER /
IL_SUB_MIPMAP
IL_SUB_NEXT
IL_TGA TrueVision Targa.
IL_TGA_AUTHCOMMENT_STRING
IL_TGA_AUTHNAME_STRING
IL_TGA_CREATE_STAMP
IL_TGA_ID_STRING
IL_TGA_RLE
IL_TIF TIFF (.tif or .tiff) image.
IL_TIF_AUTHNAME_STRING
IL_TIF_DESCRIPTION_STRING
IL_TIF_DOCUMENTNAME_STRING
IL_TIF_HOSTCOMPUTER_STRING
IL_TRUE
IL_TYPE_BIT
IL_TYPE_MODE Returns the type images are converted to upon loading.
IL_TYPE_SET Returns whether all images loaded are converted to a specific type.
IL_TYPE_UNKNOWN Tells OpenIL to try to determine the type of image present in FileName, File or Lump.
IL_UNKNOWN_ERROR No function sets this yet, but it is possible (not probable) it may be used in the future.
IL_UNSIGNED_BYTE
IL_UNSIGNED_INT
IL_UNSIGNED_SHORT
IL_USE_COMPRESSION Specifies that OpenIL should use compression when saving, if possible.
IL_USE_KEY_COLOR Returns whether OpenIL uses a key colour (not used yet).
IL_USE_KEY_COLOUR Returns whether OpenIL uses a key colour (not used yet).
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_VERSION_1_6_8
IL_VERSION_NUM Returns the version number of the shared library. This can be checked against the IL_VERSION #define.
IL_WAL Quake .wal texture.
IL_WU_QUANT
IL_XPM .xpm file.

Public Static (Shared) Methods

ilActiveImage ilActiveImage sets the current image to be an image in an animation chain
ilActiveLayer ilActiveLayer is not yet used.
ilActiveMipmap 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.
ilApplyPal
ilApplyProfile 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.
ilBindImage 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.
ilBlit
ilClearColour 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.
ilClearImage 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.
ilCloneCurImage 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.
ilCompressFunc
ilConvertImage ilConvertImage converts the current bound image from its format/type to DestFormat and DestType. Almost all conversions are allowable.
ilConvertPal 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.
ilCopyImage ilCopyImage copies the attributes and data from the image named in Src. The same image bound before calling ilCopyImage remains bound afterward.
ilCopyPixels s width, height or depth number of pixels will be copied to Data.
ilCreateSubImage
ilDefaultImage 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.
ilDeleteImage
ilDeleteImagesOverloaded. ilDeleteImages deletes Num image names specified in Image. 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).
ilDisable s OpenGL counterpart glDisable.
ilEnable s OpenGL counterpart glEnable.
ilFormatFunc
ilGenImage
ilGenImagesOverloaded. 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.
ilGetAlpha
ilGetBoolean ilGetBoolean returns the value of a selected mode.
ilGetBooleanv ilGetBooleanv function returns the mode value in the Param parameter.
ilGetData s data to allow direct access and modification to the contents of the image.
ilGetDXTCData
ilGetError 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.
ilGetInteger ilGetInteger returns the value of a selected mode.
ilGetIntegervOverloaded. ilGetIntegerv function returns the mode value in the Param parameter.
ilGetLumpPos
ilGetPalette 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.
ilGetString ilGetString returns a constant human-readable string describing the current OpenIL implementation.
ilHint s behaviour, in order to optimize either speed, memory, compression or quality, depending wholly on what the user desires.
ilInit ilInit starts DevIL and must be called prior to using DevIL, or else DevIL will probably crash when you attempt to use it.
ilIsDisabled ilIsDisabled returns whether the mode indicated by Mode is disabled.
ilIsEnabled ilIsEnabled returns whether the mode indicated by Mode is enabled.
ilIsImage 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.
ilIsValid
ilIsValidF
ilIsValidLOverloaded.
ilKeyColour
ilLoad 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.
ilLoadData
ilLoadDataF
ilLoadDataLOverloaded.
ilLoadF ilLoadF loads an image from a previously opened file
ilLoadFromJpegStruct
ilLoadImage 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.
ilLoadLOverloaded. ilLoadL loads an image from a memory lump
ilLoadPal 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.
ilModAlpha
ilOriginFunc 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.
ilOverlayImage 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.
ilPopAttrib 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
ilRegisterFormat 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
ilRegisterLoad 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
ilRegisterMipNum 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 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.
ilRegisterOrigin 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 The ilRegisterPal function registers the current image's palette.
ilRegisterSave 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.
ilRegisterType 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 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 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.
ilResetMemory
ilResetRead ilResetRead resets the reading functions set by ilSetRead.
ilResetWrite ilResetWrite resets the writing functions set by ilSetWrite.
ilSave 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.
ilSaveData
ilSaveF ilSaveF saves an image to a previously opened file
ilSaveFromJpegStruct
ilSaveImage
ilSaveLOverloaded. ilSaveL saves an image to a memory lump
ilSavePal 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.
ilSetAlpha
ilSetData 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.
ilSetDuration 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.
ilSetInteger The ilSetInteger function sets the value of a selected mode. it's the ilGetInteger's counterpart
ilSetMemory 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.
ilSetPixels 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.
ilSetRead datatype ILHANDLE is passed to these functions when used, so any internal datatype used by the differing language (or file handle) can be used.
ilSetString 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.
ilSetWrite 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.
ilShutDown
ilTexImage 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.
ilTypeFromExt
ilTypeFunc

Public Instance Methods

Equals (inherited from Object) 
GetHashCode (inherited from Object) 
GetType (inherited from Object) 
ToString (inherited from Object) 

See Also

Il Class | Tao.DevIl Namespace