aboutsummaryrefslogtreecommitdiffhomepage
path: root/evdev.lua
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2023-09-15 20:21:35 +0300
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2023-09-15 21:17:08 +0300
commit0b47e7cf9bb7b77fa28a02aea1964540b81a7c84 (patch)
treeb1b0be0317d594cac680bf69d3857253f7f0341c /evdev.lua
parent7fc0f17fb37326c86a83627b856a5b75f522c090 (diff)
downloadapplause2-0b47e7cf9bb7b77fa28a02aea1964540b81a7c84.tar.gz
documentation update
Diffstat (limited to 'evdev.lua')
-rw-r--r--evdev.lua5
1 files changed, 4 insertions, 1 deletions
diff --git a/evdev.lua b/evdev.lua
index 4eba28c..eb1a78b 100644
--- a/evdev.lua
+++ b/evdev.lua
@@ -62,10 +62,12 @@ EvdevStream = DeriveClass(Stream)
-- @treturn EvdevStream
-- A stream of C structures, describing the event in detail.
-- Its fields will be 0 if no event ocurred.
--- @todo Document the C structure as a Lua table.
-- @see Stream:evrel
-- @see Stream:evabs
-- @see Stream:evkey
+-- @todo Document the C structure as a Lua table.
+-- @todo We could introduce something like EvdevStream.list() to get at least some
+-- introspection without having to call evtest.
function EvdevStream:ctor(id, grab)
local grab = grab == nil or grab
@@ -158,6 +160,7 @@ end
-- @fixme min and max can be read from the properties of the corresponding code.
-- This would however require us to do all postprocessing already in EvdevStream:gtick()
-- or even in applause_evdev_new().
+-- Or simply overwrite this function in EvdevStream as an optimization.
function Stream:evabs(code, min, max)
code = ffi.cast("enum applause_evdev_abs", code)