ilSetString
The ilSetString function allows you to set strings to be written to files.
ILvoid ilSetString(
ILenum Mode
char *String
);
Parameters
- Mode
- Specifies the string to be set. The following values are accepted:
- IL_TGA_ID_STRING
- Specifies a string for the identification field of a .tga file. The maximum length is 254 characters.
- IL_TGA_AUTHNAME_STRING
- Specifies the author's name for a .tga file, to be put in the extensions field. The maximum length is 40 characters.
- IL_TGA_AUTHCOMMENT_STRING
- Specifies any author's comments for a .tga file, to be put in the extensions field. The maximum length is 80 characters.
- IL_PNG_AUTHNAME_STRING
- Specifies the author's name for a .png file. The maximum length is 255 characters.
- IL_PNG_TITLE_STRING
- Specifies the title of the image for a .png file. The maximum length is 255 characters.
- IL_PNG_DESCRIPTION_STRING
- Specifies a short description of the image for a .png file. The maximum length is 255 characters.
- IL_TIF_DESCRIPTION_STRING
- Specifies a short description of the image for a .tif file. The maximum length is 255 characters.
- IL_TIF_HOSTCOMPUTER_STRING
- Specifies the host computer's name for a .tif file. The maximum length is 255 characters.
- IL_TIF_DOCUMENTNAME_STRING
- Specifies the name of the image for a .tif file. The maximum length is 255 characters.
- IL_TIF_AUTHNAME_STRING
- Specifies the author's name for a .tif file. The maximum length is 255 characters.
- String
- String to use for setting a string field of a specified image format.
Remarks
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.
Error Codes
IL_INVALID_ENUM - Mode was an invalid enum.
IL_INVALID_PARAM - String was NULL.
See Also
ilGetBoolean, ilGetBooleanv, ilGetInteger, ilGetIntegerv