Skip to content

Commit 3667e2d

Browse files
committed
framebuffer-spy: Update README
1 parent c2c746c commit 3667e2d

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

framebuffer-spy/README.MD

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# framebuffer-spy
22

3-
Framebuffer-spy is a simple module which provides a single function: `void *getFramebufferAddress()` which returns the address of the framebuffer created by xochitl.
4-
**As of right now, only compatible with rMPP**
3+
Framebuffer-spy is a simple module which provides info on the rM tablet's framebuffer.
4+
5+
Functions:
6+
7+
- FramebufferConfig getFramebufferConfig() - returns a config object, as defined in `framebuffer-spy.h`
8+
- char *getConfigString() - returns a heap-allocated string-serialized FramebufferConfig object (`"0xAddress,width,height,type,bpl,requiresReload"`)
9+
- void refreshFramebuffer() - this function needs to be called before accessing the framebuffer data, if the `config.requiresReload` value is set
10+
11+
Additionally, getConfigString is a xovi-message-broker export (`framebuffer-spy$getConfigString`), which makes it simple to access this data from software outside of xochitl.

0 commit comments

Comments
 (0)