Skip to content

Commit 742d91b

Browse files
committed
Merge pull request godotengine#105055 from Mickeon/documentation-typo-Windows-exclude-from-capture
Fix typo in Window's `exclude_from_capture`
2 parents 21d00f6 + f60c98f commit 742d91b

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

doc/classes/DisplayServer.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2188,9 +2188,9 @@
21882188
[b]Note:[/b] This flag is implemented only on Windows (11).
21892189
</constant>
21902190
<constant name="WINDOW_FLAG_EXCLUDE_FROM_CAPTURE" value="9" enum="WindowFlags">
2191-
Windows is excluded from screenshots taken by [method screen_get_image], [method screen_get_image_rect], and [method screen_get_pixel].
2191+
Window is excluded from screenshots taken by [method screen_get_image], [method screen_get_image_rect], and [method screen_get_pixel].
21922192
[b]Note:[/b] This flag is implemented on macOS and Windows.
2193-
[b]Note:[/b] Setting this flag will [b]NOT[/b] prevent other apps from capturing an image, it should not be used as a security measure.
2193+
[b]Note:[/b] Setting this flag will [b]NOT[/b] prevent other apps from capturing an image. It should not be used as a security measure.
21942194
</constant>
21952195
<constant name="WINDOW_FLAG_POPUP_WM_HINT" value="10" enum="WindowFlags">
21962196
Signals the window manager that this window is supposed to be an implementation-defined "popup" (usually a floating, borderless, untileable and immovable child window).

doc/classes/Window.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -600,7 +600,9 @@
600600
The screen the window is currently on.
601601
</member>
602602
<member name="exclude_from_capture" type="bool" setter="set_flag" getter="get_flag" default="false">
603-
Windows is excluded from screenshots taken by [method DisplayServer.screen_get_image], [method DisplayServer.screen_get_image_rect], and [method DisplayServer.screen_get_pixel].
603+
If [code]true[/code], the [Window] is excluded from screenshots taken by [method DisplayServer.screen_get_image], [method DisplayServer.screen_get_image_rect], and [method DisplayServer.screen_get_pixel].
604+
[b]Note:[/b] This property is implemented on macOS and Windows.
605+
[b]Note:[/b] Enabling this setting does [b]NOT[/b] prevent other apps from capturing an image. It should not be used as a security measure.
604606
</member>
605607
<member name="exclusive" type="bool" setter="set_exclusive" getter="is_exclusive" default="false">
606608
If [code]true[/code], the [Window] will be in exclusive mode. Exclusive windows are always on top of their parent and will block all input going to the parent [Window].

0 commit comments

Comments
 (0)