diff options
| author | Sven Gothel <[email protected]> | 2010-11-09 08:06:28 +0100 |
|---|---|---|
| committer | Sven Gothel <[email protected]> | 2010-11-09 08:06:28 +0100 |
| commit | eddf305ce33ec1da8f1bc94337e81927ac1bcbae (patch) | |
| tree | 6f85a4f20d41c6ca3760696c218cbd8739e97f44 /src/java/com/jogamp/gluegen/package.html | |
| parent | 37dea2b98c67cb6b32baf88022e75cfc3b71879e (diff) | |
Enhance API doc .. package description etc
Diffstat (limited to 'src/java/com/jogamp/gluegen/package.html')
| -rw-r--r-- | src/java/com/jogamp/gluegen/package.html | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/src/java/com/jogamp/gluegen/package.html b/src/java/com/jogamp/gluegen/package.html new file mode 100644 index 0000000..68f4eb9 --- /dev/null +++ b/src/java/com/jogamp/gluegen/package.html @@ -0,0 +1,62 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <title>GlueGen Code Generator</title> +</head> + <body> +<h2><i>JogAmp GlueGen</i> Code Generator</h2> + <p> + <h4>GlueGen Data Type Mapping</h4> + Gluegen has build-in types (terminal symbols) for:<br> + <br> + <table border="1"> + <tr><th>type</th> <th>java</th> <th>native-x32</th><th>native-x64</th><th>type</th> <th>signed</th> <th>origin</th</tr> + <tr><th>__int32</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>signed or unsigned</th><th>windows</th></tr> + <tr><th>int32_t</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>signed</th> <th>stdint.h</th></tr> + <tr><th>wchar_t</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>signed</th> <th>stddef.h</th></tr> + <tr><th>uint32_t</th> <th>32bit</th><th>32bit</th> <th>32bit</th> <th>integer</th><th>unsigned</th> <th>stdint.h</th></tr> + <tr><th>__int64</th> <th>64bit</th><th>64bit</th> <th>64bit</th> <th>integer</th><th>signed or unsigned</th><th>windows</th></tr> + <tr><th>int64_t</th> <th>64bit</th><th>64bit</th> <th>64bit</th> <th>integer</th><th>signed</th> <th>stdint.h</th></tr> + <tr><th>uint64_t</th> <th>64bit</th><th>64bit</th> <th>64bit</th> <th>integer</th><th>unsigned</th> <th>stdint.h</th></tr> + <tr><th>ptrdiff_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>signed</th> <th>stddef.h</th></tr> + <tr><th>intptr_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>signed</th> <th>stdint.h</th></tr> + <tr><th>size_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>unsigned</th> <th>stddef.h</th></tr> + <tr><th>uintptr_t</th> <th>64bit</th><th>32bit</th> <th>64bit</th> <th>integer</th><th>unsigned</th> <th>stdint.h</th></tr> + </table> + </p> + <p> + <h4>GlueGen Platform Header Files</h4> + GlueGen provides convenient platform headers,<br> + which can be included in your C header files for native compilation and GlueGen code generation.<br> + <br> + Example:<br> + <pre> + #include <gluegen_stdint.h> + #include <gluegen_stddef.h> + + uint64_t test64; + size_t size1; + ptrdiff_t ptr1; + </pre> + <br> + To compile this file you have to include the following folder to your compilers system includes, ie <code>-I</code>:<br> + <pre> + gluegen/make/stub_includes/platform + </pre> + <br> + To generate code for this file you have to include the following folder to your GlueGen <code>includeRefid</code> element:<br> + <pre> + gluegen/make/stub_includes/gluegen + </pre> + </p> + <p> + <h4>GlueGen Pre-Defined Macros</h4> + To identity a GlueGen code generation run, GlueGen defines the following macros:<br> + <pre> + #define __GLUEGEN__ 2 + </pre> + </p> + <br> + <br> +</body> +</html> |