wanp/townengine
2
1
Fork 0
Code Issues 6 Pull Requests Packages Projects Releases Wiki Activity

update interop.md

Browse Source
This commit is contained in:
veclavtalica
2024-11-03 23:25:06 +03:00
parent 4be27816c2
commit a7feb7b61b
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/interop.md
View File

@@ -5,11 +5,11 @@ for that certain considerations are taken:
* number of public api calls is kept at the minimum
* procedure parameters can only use basic types, no aggregates, with exception of Vec/Matrix types and alike,
with no expectation on new additions (see [/include/twn_types.h](../include/twn_types.h))
* optionals can be expressed via pointer passage of value primitives, with NULL expressive default, but they should be immutable
* opaque typed parameters are passed around as pointers
* when mutation on input is done, - it shouldn't be achieved from a mutable pointer, but return value
* return value could be a simple aggregate that is translatable to value-only dictionary
* optionals can be expressed via pointer passage of value primitives, assumed immutable, with the NULL expressing default
* no opaque types, only keys
* when mutation on input is done, - it shouldn't be achieved from a mutable pointer, but the return value
* return value could be a simple aggregate that is translatable to pure data dictionary
* module prefix is used for namespacing, actual symbols come after the prefix (`module_symbol`)
* symbols should not contain letters at the start nor after the namespace prefix
* floats are preferred over integers
* [/include/twn_api.json](../include/twn_api.json) file is hand-kept with a schema to aid automatic binding generation and other tooling
* 32 bit floating point is the only numeric type
* [/include/twn_api.json](../include/twn_api.json) file is hand-kept with a schema to aid automatic binding generation and tooling