Fix a comment typo.

[nageru] / nageru / simple.lua

diff --git a/nageru/simple.lua b/nageru/simple.lua
index 5444a200be9787c0e8c1f62269dcf6f0d7ccfe45..e799f80a683c49ab0831a348186a2414aa75154b 100644 (file)
--- a/nageru/simple.lua
+++ b/nageru/simple.lua
@@ -25,28 +25,25 @@ local input = scene:add_input()
 local wb_effect = scene:add_effect(WhiteBalanceEffect.new())
 scene:finalize()
 
--- Set some global state.
-Nageru.set_num_channels(2)  -- Can only be called at the start of the program.
+-- Set some global state. Unless marked otherwise, these can only be set once,
+-- at the start of the program.
+Nageru.set_num_channels(2)
+
+-- Sets, for each channel, which signal it corresponds to (starting from 0).
+-- The information is used for whether right-click on the channel should bring up
+-- an input selector or not. Only call this for channels that actually correspond
+-- directly to a signal (ie., live inputs, not live (0) or preview (1)).
+Nageru.set_channel_signal(2, 0)
+Nageru.set_channel_signal(3, 1)
+
+-- Set whether a given channel supports setting white balance. (Default is false.)
+Nageru.set_supports_wb(2, true)
+Nageru.set_supports_wb(3, true)
+
+-- These can be set at any time.
 Nageru.set_channel_name(2, "First input")
 Nageru.set_channel_name(3, "Second input")
 
--- API ENTRY POINT
--- Returns, given a channel number, which signal it corresponds to (starting from 0).
--- Should return -1 if the channel does not correspond to a simple signal.
--- (The information is used for whether right-click on the channel should bring up
--- an input selector or not.)
--- Called once for each channel, at the start of the program.
--- Will never be called for live (0) or preview (1).
-function channel_signal(channel)
-       if channel == 2 then
-               return 0
-       elseif channel == 3 then
-               return 1
-       else
-               return -1
-       end
-end
-
 -- API ENTRY POINT
 -- Called every frame. Returns the color (if any) to paint around the given
 -- channel. Returns a CSS color (typically to mark live and preview signals);
@@ -56,13 +53,6 @@ function channel_color(channel)
        return "transparent"
 end
 
--- API ENTRY POINT
--- Returns if a given channel supports setting white balance (starting from 2).
--- Called only once for each channel, at the start of the program.
-function supports_set_wb(channel)
-       return channel == 2 or channel == 3
-end
-
 -- API ENTRY POINT
 -- Gets called with a new gray point when the white balance is changing.
 -- The color is in linear light (not sRGB gamma).
@@ -109,8 +99,10 @@ end
 --
 -- <signals> is basically an exposed InputState, which you can use to
 -- query for information about the signals at the point of the current
--- frame. In particular, you can call get_width() and get_height()
+-- frame. In particular, you can call get_frame_width() and get_frame_height()
 -- for any signal number, and use that to e.g. assist in scene selection.
+-- (You can also use get_width() and get_height(), which return the
+-- _field_ size. This has half the height for interlaced signals.)
 --
 -- You should return the scene to use, after having set any parameters you
 -- want to set (through set_int() etc.). The parameters will be snapshot