ilGetBoolean, ilGetBooleanv, ilGetInteger, ilGetIntegerv
These functions return the value of a selected mode.
ILboolean ilGetBoolean(
ILenum Mode
);
ILvoid ilGetBooleanv(
ILenum Mode,
ILboolean *Param
);
ILint ilGetInteger(
ILenum Mode
);
ILvoid ilGetIntegerv(
ILenum Mode,
ILint *Param
);
Parameters
- Mode
- The mode value to be returned. The following values are accepted:
- IL_FILE_MODE
- Returns whether file overwriting when saving is enabled.
- IL_CONV_PAL
- Returns whether palette'd images are converted to their base palettes types on load - e.g. converted to a BGRA image.
- IL_ORIGIN_SET
- Returns whether all images loaded and saved adhere to a specific origin.
- IL_ORIGIN_MODE
- Returns the current origin position. Returned values can be:
- IL_ORIGIN_LOWER_LEFT
- The origin is in the lower left corner.
- IL_ORIGIN_UPPER_LEFT
- The origin is in the upper left corner.
- IL_FORMAT_SET
- Returns whether all images loaded are converted to a specific format.
- IL_FORMAT_MODE
- Returns the format images are converted to upon loading.
- IL_TYPE_SET
- Returns whether all images loaded are converted to a specific type.
- IL_TYPE_MODE
- Returns the type images are converted to upon loading.
- IL_VERSION_NUM
- Returns the version number of the shared library. This can be checked against the IL_VERSION #define.
- IL_IMAGE_WIDTH
- Returns the current image's width.
- IL_IMAGE_HEIGHT
- Returns the current image's height.
- IL_IMAGE_BYTES_PER_PIXEL
- Returns the bytes per pixel of the current image's data.
- IL_IMAGE_BITS_PER_PIXEL
- Returns the bits per pixel of the current image's data.
- IL_IMAGE_FORMAT
- Returns the current image's format.
- IL_IMAGE_TYPE
- Returns the current image's type.
- IL_NUM_IMAGES
- Returns the number of images in the current image animation chain.
- IL_NUM_MIPMAPS
- Returns the number of mipmaps of the current image.
- IL_PALETTE_TYPE
- Returns the palette type of the current image.
- IL_PALETTE_BPP
- Returns the bytes per pixel of the current image's palette.
- IL_PALETTE_NUM_COLS
- Returns the number of colours of the current image's palette.
- 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_CUR_IMAGE
- Returns the current bound image name.
- IL_USE_KEY_COLOUR
- Returns whether DevIL uses a key colour (not used yet).
- Param
- When used, the value is stored here instead of returned.
Remarks
The ilGetBoolean and ilGetInteger functions return the value of a selected mode. The ilGetBooleanv and ilGetIntegerv functions return the mode value in the Param parameter.
Error Codes
IL_INVALID_ENUM - Mode was an invalid enum.
IL_INVALID_PARAM - Param was NULL.
See Also
ilEnable, ilDisable, ilOriginFunc, iluGetInteger, iluGetIntegerv, ilutGetBoolean, ilutGetBooleanv, ilutGetInteger, ilutGetIntegerv, ilSetInteger