From 324d19f83238b2adf7ef81d4cda10b0bfec2463c Mon Sep 17 00:00:00 2001 From: "Steinar H. Gunderson" Date: Fri, 22 Jul 2022 01:05:58 +0200 Subject: [PATCH] Update the comment on get_scene() about the signals parameter. Users won't know what InputState is, and scene selection isn't a thing anymore after the themes became a thing. --- nageru/simple.lua | 13 +++++++------ nageru/theme.lua | 13 +++++++------ 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/nageru/simple.lua b/nageru/simple.lua index e799f80..bac31d6 100644 --- a/nageru/simple.lua +++ b/nageru/simple.lua @@ -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). -- --- 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.) +-- 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 diff --git a/nageru/theme.lua b/nageru/theme.lua index b95d1e1..1fc7d11 100644 --- a/nageru/theme.lua +++ b/nageru/theme.lua @@ -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). -- --- 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.) +-- 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 -- 2.39.2