/
Environment_BGMode.hx
49 lines (40 loc) · 1.4 KB
/
Environment_BGMode.hx
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
48
49
// Automatically generated Godot externs: DO NOT EDIT
// MIT licensed, see LICENSE.md
package godot;
@:native("Godot.Environment.BGMode")
@:csNative
extern enum Environment_BGMode {
/**
Clears the background using the clear color defined in .
**/
ClearColor;
/**
Clears the background using a custom clear color.
**/
Color;
/**
Displays a user-defined sky in the background.
**/
Sky;
/**
Clears the background using a custom clear color and allows defining a sky for shading and reflection. This mode is slightly faster than `godot.Environment_BGMode.sky` and should be preferred in scenes where reflections can be visible, but the sky itself never is (e.g. top-down camera).
**/
ColorSky;
/**
Displays a `godot.CanvasLayer` in the background.
**/
Canvas;
/**
Keeps on screen every pixel drawn in the background. Only select this mode if you really need to keep the old data. On modern GPUs it will generally not be faster than clearing the background, and can be significantly slower, particularly on mobile.
It can only be safely used in fully-interior scenes (no visible sky or sky reflections). If enabled in a scene where the background is visible, "ghost trail" artifacts will be visible when moving the camera.
**/
Keep;
/**
Displays a camera feed in the background.
**/
CameraFeed;
/**
Represents the size of the `godot.Environment_BGMode` enum.
**/
Max;
}