mhu/gds-render
1
0
Fork 0
Code Issues 4 Pull Requests Actions Releases 8 Wiki Activity

Modify External Renderer: External renderer docu updated for future changes, restructuring. Not that the changes in the documentation are not yet implemented in code

Browse Source
This commit is contained in:
Mario Hüttel
2019-11-12 20:52:42 +01:00
parent daf12a7d8c
commit f15e82b5dc
5 changed files with 59 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doxygen/external-renderer.dox
View File

@@ -12,4 +12,14 @@
*
* All these properties have to be set for rendering.
*
* @section ExternalRendererFuncs Necessary Functions
*
* The following functions and variables are necessary for an external renderer to implement:
*
* Code Define | Prototype | Description
* ---------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------
* @ref EXTERNAL_LIBRARY_RENDER_FUNCTION | int EXTERNAL_LIBRARY_RENDER_FUNCTION(struct gds_cell *toplevel, GList *layer_info_list, const char *output_file_name, double scale) | Render cell to output file
* @ref EXTERNAL_LIBRARY_INIT_FUNCTION | int EXTERNAL_LIBRARY_INIT_FUNCTION(const char *option_string, const char *version_string) | Init function. Executed before rendering. This is given the command line parameters specified for the external renderer and the version string of the currently running gds-render program.
* @ref EXTERNAL_LIBRARY_FORK_REQUEST | int EXTERNAL_LIBRARY_FORK_REQUEST; | The pure presence of this integer results in the execution inside a subprocess of hte whole shared object's code
*
*/