Difference between revisions of "Global Command: getWindowBrightness"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | Returns the brightness (gamma) of the window. A value of 0 is completely dark, 100 is normal brightness. | |
| − | |||
| − | |||
| − | |||
| − | |||
| + | {| class="ts" | ||
| + | |- | ||
| + | | style="width:15%" | Related functions | ||
| + | | [[Global Command: setWindowBrightness|setWindowBrightness]] | ||
| + | |} | ||
| − | |||
| − | + | == Syntax == | |
| − | Syntax | + | <syntaxhighlight lang="lua"> |
| − | <syntaxhighlight> | ||
getWindowBrightness() | getWindowBrightness() | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | == Parameters == | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
none | none | ||
| − | + | == Return values == | |
| − | + | {| class="ts" | |
| + | |- | ||
| + | ! style="width:15%" | Type | ||
| + | ! Description | ||
| + | |- | ||
| + | | integer | ||
| + | | The current gamma/brightness value in the range of 0 (completely dark) to 100 (normal brightness). | ||
| + | |} | ||
| − | + | == Examples == | |
| − | |||
| − | |||
| − | + | '''Example 1:''' Do something, if the brightness value is less than 50%. | |
| − | + | <syntaxhighlight lang ="lua"> | |
| − | + | if getWindowBrightness() < 50 then | |
| − | + | -- do something | |
| − | + | end | |
| − | + | </syntaxhighlight> | |
| + | {{toc}} | ||
Latest revision as of 23:45, 15 May 2023
Returns the brightness (gamma) of the window. A value of 0 is completely dark, 100 is normal brightness.
| Related functions | setWindowBrightness |
Syntax
getWindowBrightness()
Parameters
none
Return values
| Type | Description |
|---|---|
| integer | The current gamma/brightness value in the range of 0 (completely dark) to 100 (normal brightness). |
Examples
Example 1: Do something, if the brightness value is less than 50%.
if getWindowBrightness() < 50 then
-- do something
end
