diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c234d19 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# lua texture-share-vk + +A LÖVE library for sharing GPU textures between processes. + +This wraps the OpenGL C API of [texture-share-vk](https://github.com/DigitOtter/texture-share-vk) and allows publishing a LÖVE Canvas object. + +## API + +- `tvs.new()`: creates a new `Client` object (`texture-share-gl` client). +- `Client:newSharedCanvas(name, ...)`: creates a new `SharedCanvas` object by delegating to [`love.graphics.newCanvas(...)`](https://love2d.org/wiki/love.graphics.newCanvas) and publishes it. +- `Canvas.name`: the name passed in the SharedCanvas constructor +- `Canvas.canvas`: the love2d `Canvas` object +- `Canvas:send()`: Sends the current contents of the Canvas to subscribers, call this after drawing to the Canvas. +- `Canvas:any_other_method()`: delegated to the love2d `Canvas` object |