diff options
Diffstat (limited to 'intern/ghost/GHOST_C-api.h')
-rw-r--r-- | intern/ghost/GHOST_C-api.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h index 2574b84e51c..35191c4e45d 100644 --- a/intern/ghost/GHOST_C-api.h +++ b/intern/ghost/GHOST_C-api.h @@ -28,6 +28,11 @@ * * ***** END GPL/BL DUAL LICENSE BLOCK ***** */ +/** + * @file GHOST_C-api.h + * GHOST C-API function and type declarations. + * The C-API wraps the C++ objects with the + */ #ifndef GHOST_C_API_H #define GHOST_C_API_H @@ -38,6 +43,12 @@ extern "C" { #endif +/** + * Creates a "handle" for a C++ GHOST object. + * A handle is just an opaque pointer to an empty struct. + * In the API the pointer is casted to the actual C++ class. + * @param name Name of the handle to create. + */ #define GHOST_DECLARE_HANDLE(name) typedef struct name##__ { int unused; } *name GHOST_DECLARE_HANDLE(GHOST_SystemHandle); |