summaryrefslogtreecommitdiff
path: root/include/im.h
diff options
context:
space:
mode:
authorscuri <scuri>2009-08-19 18:39:31 +0000
committerscuri <scuri>2009-08-19 18:39:31 +0000
commit43522c5f2a12dc0cf3cda733e4fb5c04cd62a154 (patch)
tree898c6d10776a5e8e50dc93c7c51d334e5bc79cb3 /include/im.h
parent40b9c00bf632734a5871c78d58c7661f1b0988a0 (diff)
*** empty log message ***
Diffstat (limited to 'include/im.h')
-rw-r--r--include/im.h13
1 files changed, 9 insertions, 4 deletions
diff --git a/include/im.h b/include/im.h
index a6673cb..a324199 100644
--- a/include/im.h
+++ b/include/im.h
@@ -114,9 +114,13 @@ void imFileClose(imFile* ifile);
void* imFileHandle(imFile* ifile, int index);
/** Returns file information.
- * image_count is the number of images in a stack or
- * the number of frames in a video/animation or the depth of a volume data. \n
- * compression and image_count can be NULL.
+ * image_count is the number of images in a stack or
+ * the number of frames in a video/animation or the depth of a volume data. \n
+ * compression and image_count can be NULL. \n
+ * These informations are also available as attributes:
+ * \verbatim FileFormat (string) \endverbatim
+ * \verbatim FileCompression (string) \endverbatim
+ * \verbatim FileImageCount IM_INT (1) \endverbatim
* See also \ref format.
*
* \verbatim ifile:GetInfo() -> format: string, compression: string, image_count: number [in Lua 5] \endverbatim
@@ -134,7 +138,8 @@ void imFileSetInfo(imFile* ifile, const char* compression);
/** Changes an extended attribute. \n
* The data will be internally duplicated. \n
- * If data is NULL the attribute is removed.
+ * If data is NULL the attribute is removed.
+ * If data_type is BYTE then count can be -1 to indicate a NULL terminated string.
* See also \ref imDataType.
*
* \verbatim ifile:SetAttribute(attrib: string, data_type: number, data: table of numbers or string) [in Lua 5] \endverbatim