]> git.sesse.net Git - nageru/commitdiff
Update the comment on get_scene() about the signals parameter.
authorSteinar H. Gunderson <sgunderson@bigfoot.com>
Thu, 21 Jul 2022 23:05:58 +0000 (01:05 +0200)
committerSteinar H. Gunderson <sgunderson@bigfoot.com>
Thu, 21 Jul 2022 23:05:58 +0000 (01:05 +0200)
Users won't know what InputState is, and scene selection isn't
a thing anymore after the themes became a thing.

nageru/simple.lua
nageru/theme.lua

index e799f80a683c49ab0831a348186a2414aa75154b..bac31d69d492b40a60a95436c1033f91408cc47d 100644 (file)
@@ -97,12 +97,13 @@ end
 -- 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).
 --
--- <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_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.)
+-- <signals> is an object which you can query for information
+-- about the signals at the point of the current frame. In particular,
+-- you can call get_frame_width() and get_frame_height() for any
+-- signal number, and use that to e.g. see if you wish to enable
+-- a scaler or not. (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
index b95d1e168d0efc413b44832fd8673f75f7f9aeb1..1fc7d117ea49e4e8e8dc91fb8f1680d5e6b49064 100644 (file)
@@ -325,12 +325,13 @@ end
 -- 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).
 --
--- <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_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.)
+-- <signals> is an object which you can query for information
+-- about the signals at the point of the current frame. In particular,
+-- you can call get_frame_width() and get_frame_height() for any
+-- signal number, and use that to e.g. see if you wish to enable
+-- a scaler or not. (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 scene to use, after having set any parameters you
 -- want to set (through set_int() etc.). The parameters will be snapshot