diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-12 12:50:17 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-06-12 12:50:17 +0200 |
| commit | 0e6cac8ab8cfa59274b51ab68d59fca8168b0c41 (patch) | |
| tree | 67493fa7eef5b3452847b147ce93aa7ff1fe0316 /doc/classes | |
| parent | 971b5160c61ccb7a009966d17d339997ea343da3 (diff) | |
| parent | 54863b20e686944651415bf0a6af3ebc2cf9369f (diff) | |
Merge pull request #29465 from bruvzg/per_pixel_transp_impr
Removes redundant "splash" setting, improves per pixel transparency documentation.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/OS.xml | 4 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 5 |
2 files changed, 6 insertions, 3 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index f7cd6c3e83..2592bc6775 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -818,6 +818,7 @@ </member> <member name="window_borderless" type="bool" setter="set_borderless_window" getter="get_borderless_window"> If [code]true[/code], removes the window frame. + Note: Setting [code]window_borderless[/code] to [code]false[/code] disables per-pixel transparency. </member> <member name="window_fullscreen" type="bool" setter="set_window_fullscreen" getter="is_window_fullscreen"> If [code]true[/code], the window is fullscreen. @@ -829,6 +830,9 @@ If [code]true[/code], the window is minimized. </member> <member name="window_per_pixel_transparency_enabled" type="bool" setter="set_window_per_pixel_transparency_enabled" getter="get_window_per_pixel_transparency_enabled"> + If [code]true[/code], the window background is transparent and window frame is removed. + Use [code]get_tree().get_root().set_transparent_background(true)[/code] to disable main viewport background rendering. + Note: This property has no effect if "Project > Project Settings > Display > Window > Per-pixel transparency > Allowed" setting is disabled. </member> <member name="window_position" type="Vector2" setter="set_window_position" getter="get_window_position"> The window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 460db5e792..196fcbfaaa 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -374,11 +374,10 @@ Default orientation on mobile devices. </member> <member name="display/window/per_pixel_transparency/allowed" type="bool" setter="" getter=""> - If [code]true[/code], allows per-pixel transparency in a desktop window. This affects performance if not needed, so leave it on [code]false[/code] unless you need it. + If [code]true[/code], allows per-pixel transparency in a desktop window. This affects performance, so leave it on [code]false[/code] unless you need it. </member> <member name="display/window/per_pixel_transparency/enabled" type="bool" setter="" getter=""> - </member> - <member name="display/window/per_pixel_transparency/splash" type="bool" setter="" getter=""> + Set the window background to transparent when it starts. </member> <member name="display/window/size/always_on_top" type="bool" setter="" getter=""> Force the window to be always on top. |