q98/sokol-luajit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More readme updates

Browse Source
This commit is contained in:
David Lannan 2024-10-31 16:07:57 +10:30
parent dbeea7470f
commit 9dc11a5288
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -25,7 +25,7 @@ You will also need to modify the paths at the top of the samples lua scripts to
The Wasm part of sokol might not be able to be utilized in this manner. However I do have plans to compile Luajit->wasm and embed sokol generated bytecode. It should be possible, but that is along term goal.
## Examples
I have ported 5 examples from sokol, and will be adding more. These show how the ffi interface can be used.
I have ported examples from sokol, and will be adding more. These show how the ffi interface can be used.
How to use the example. Open a command window or powershell in the repo folder (Win64 powershell shown below)
@ -34,12 +34,6 @@ PS sokol-luajit> cd .\examples\
PS sokol-luajit\examples> .\run_sample.bat cube_sapp
```
Some notes:
- There are a number of objects that must be created as pointers. In ffi the easiest way to do this is to make an array object of size 1 and this way the handle in lua is a pointer and the object access uses the array indexing.
- No performance considerations have been taken into account. These are almost direct 1 to 1 mappings of the sokol C samples to luajit samples.
- pathing is not yet made friendly.
Use the run_sample bat file with one of the following parameters:
| Command | Description |
|---------|-------------|
@ -55,6 +49,11 @@ Use the run_sample bat file with one of the following parameters:
|```sdf_sapp``` | SDF from the Sokol samples |
|```remotery_cube```| A spinning cube with Remotery backend. Open /tools/remotery/vis/index.html in your browser. |
Some notes:
- There are a number of objects that must be created as pointers. In ffi the easiest way to do this is to make an array object of size 1 and this way the handle in lua is a pointer and the object access uses the array indexing.
- No performance considerations have been taken into account. These are almost direct 1 to 1 mappings of the sokol C samples to luajit samples.
- pathing is not yet made friendly (31/10/2024 - It has been improved dramatically. Little more to do.)
Feel free to contribute or post issues/ideas comment. I put this together yesterday, and its very rudimentary atm.
Screenshots: