diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 4 |
1 files changed, 3 insertions, 1 deletions
@@ -2,13 +2,15 @@ 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. +This wraps the OpenGL C API of [texture-share-vk](https://github.com/DigitOtter/texture-share-vk) and allows sending and receiving LÖVE Canvas contents. ## 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. +- `Client:loadSharedCanvas(name)`: loads a `SharedCanvas` object from another publisher. - `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:load()`: Loads updated contents from the publisher, call this before drawing the Canvas. - `Canvas:any_other_method()`: delegated to the love2d `Canvas` object |