summaryrefslogtreecommitdiff
path: root/im/include/imlua.h
diff options
context:
space:
mode:
Diffstat (limited to 'im/include/imlua.h')
-rwxr-xr-xim/include/imlua.h14
1 files changed, 3 insertions, 11 deletions
diff --git a/im/include/imlua.h b/im/include/imlua.h
index 5714dff..ad61889 100755
--- a/im/include/imlua.h
+++ b/im/include/imlua.h
@@ -11,23 +11,13 @@
extern "C" {
#endif
-/** \defgroup imlua IM Lua 5 Binding
+/** \defgroup imlua ImLua 5 Binding Reference
* \par
* Binding for the Lua 5 scripting language. \n
* Lua 5.1 Copyright (C) 1994-2005 Lua.org, PUC-Rio \n
* R. Ierusalimschy, L. H. de Figueiredo & W. Celes \n
* http://www.lua.org
* \par
- * The name of the functions were changed because of the namespace "im" and because of the object orientation. \n
- * As a general rule use:
-\verbatim
- imXxx -> im.Xxx
- IM_XXX -> im.XXX
- imFileXXX(ifile,... -> ifile:XXX(...
- imImageXXX(image,... -> image:XXX(...
-\endverbatim
- * All the objects are garbage collected by the Lua garbage collector.
- * \par
* See \ref imlua.h
* \ingroup util */
@@ -44,6 +34,7 @@ void imlua_open(void);
int imlua_open(lua_State *L);
int luaopen_imlua(lua_State *L);
+#ifdef __IM_IMAGE_H /* must include im_image.h before this */
/** Pushes an image as a metatable on the stack.
* \ingroup imlua */
void imlua_pushimage(lua_State *L, imImage* image);
@@ -51,6 +42,7 @@ void imlua_pushimage(lua_State *L, imImage* image);
/** Gets an image as a metatable from the stack, checks for correct type.
* \ingroup imlua */
imImage* imlua_checkimage(lua_State *L, int param);
+#endif
/** Initializes the Lua binding of the capture library. \n
* Returns 1 (leaves the "im" table on the top of the stack).