Difference between revisions of "Camera.setFlash"
From GiderosMobile
(Created page with "__NOTOC__ <languages /> '''<translate>Available since</translate>:''' Gideros 2021.8<br/> '''<translate>Class</translate>:''' camera<br/> === <tr...") |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''Available since:''' Gideros 2021.8<br/> | |
| − | ''' | + | '''Class:''' [[camera]]<br/> |
| − | ''' | + | |
| − | === | + | === Description === |
| − | + | Sets the flash mode to use. | |
| − | + | <syntaxhighlight lang="lua"> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | < | ||
(boolean) = camera.setFlash(mode) | (boolean) = camera.setFlash(mode) | ||
| − | </ | + | </syntaxhighlight> |
| − | === | + | |
| − | ''' | + | Possible ''mode'' values are: |
| − | === | + | * '''0''': Automatic |
| − | ''' | + | * '''1''': Flash On |
| + | * '''2''': Flash Off | ||
| + | * '''3''': Torch mode | ||
| + | * '''4''': Red-eye cancel mode (Android only) | ||
| + | |||
| + | === Parameters === | ||
| + | '''mode''' (number) one of the flash mode constants<br/> | ||
| + | |||
| + | === Return values === | ||
| + | '''Returns''' (number) False if an error occured<br/> | ||
{{Camera}} | {{Camera}} | ||
Latest revision as of 14:27, 13 July 2023
Available since: Gideros 2021.8
Class: camera
Description
Sets the flash mode to use.
(boolean) = camera.setFlash(mode)
Possible mode values are:
- 0: Automatic
- 1: Flash On
- 2: Flash Off
- 3: Torch mode
- 4: Red-eye cancel mode (Android only)
Parameters
mode (number) one of the flash mode constants
Return values
Returns (number) False if an error occured
