]> git.sesse.net Git - nageru/commitdiff
Improve the help in the theme a bit.
authorSteinar H. Gunderson <sgunderson@bigfoot.com>
Wed, 7 Oct 2015 22:24:23 +0000 (00:24 +0200)
committerSteinar H. Gunderson <sgunderson@bigfoot.com>
Wed, 7 Oct 2015 22:24:23 +0000 (00:24 +0200)
theme.lua

index 82339f8d33db7c03d9fb8c51f1b6060373cef6b9..bf88f98404f2ef5beb3a378b55d5a23f924338e2 100644 (file)
--- a/theme.lua
+++ b/theme.lua
@@ -56,6 +56,13 @@ end
 -- current time in seconds. width and height are the dimensions of
 -- the output, although you can ignore them if you don't need them
 -- (they're useful if you want to e.g. know what to resample by).
+--
+-- You should return two objects; the chain itself, and then a
+-- function (taking no parameters) that is run just before rendering.
+-- The function needs to call connect_signal on any inputs, so that
+-- it gets updated video data for the given frame. (You are allowed
+-- to switch which input your input is getting from between frames,
+-- but not calling connect_signal results in undefined behavior.)
 -- If you want to change any parameters in the chain, this is also
 -- the right place.
 --