File: video.md

package info (click to toggle)
surgescript 0.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,200 kB
  • sloc: ansic: 15,748; sh: 61; javascript: 38; makefile: 13
file content (47 lines) | stat: -rw-r--r-- 863 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Video
=====

Video settings.

*Example*

```cs
// display the current Video mode
using SurgeEngine.Video;

object "Application"
{
    state "main"
    {
        Console.print(Video.mode);
        state = "done";
    }

    state "done"
    {
    }
}
```

Properties
----------

#### fullscreen

`fullscreen`: boolean.

Whether or not the engine is running on fullscreen mode. Use this property to toggle between windowed and fullscreen modes.

*Available since:* Open Surge 0.6.1

#### mode

`mode`: string.

The current video mode. The following are the valid values:

* `"default"`: the size of the [screen](#screen) is set to its default.
* `"fill"`: the size of the screen is set to the size of the window.
* `"best-fit"`: similar to `"fill"`, except that the aspect ratio of the default size of the screen is maintained.

*Available since:* Open Surge 0.6.1