Merge pull request #109813 from bruvzg/exc_note

Clarify that `EXCLUDE_FROM_CAPTURE` only works with native windows.
This commit is contained in:
Thaddeus Crews 2025-08-21 06:24:24 -05:00
commit c8e0845b86
No known key found for this signature in database
GPG key ID: 8C6E5FEB5FC03CCC

View file

@ -904,6 +904,7 @@
</constant> </constant>
<constant name="FLAG_EXCLUDE_FROM_CAPTURE" value="9" enum="Flags"> <constant name="FLAG_EXCLUDE_FROM_CAPTURE" value="9" enum="Flags">
Windows is excluded from screenshots taken by [method DisplayServer.screen_get_image], [method DisplayServer.screen_get_image_rect], and [method DisplayServer.screen_get_pixel]. Windows is excluded from screenshots taken by [method DisplayServer.screen_get_image], [method DisplayServer.screen_get_image_rect], and [method DisplayServer.screen_get_pixel].
[b]Note:[/b] This flag has no effect in embedded windows.
[b]Note:[/b] This flag is implemented on macOS and Windows (10, 20H1). [b]Note:[/b] This flag is implemented on macOS and Windows (10, 20H1).
[b]Note:[/b] Setting this flag will prevent standard screenshot methods from capturing a window image, but does [b]NOT[/b] guarantee that other apps won't be able to capture an image. It should not be used as a DRM or security measure. [b]Note:[/b] Setting this flag will prevent standard screenshot methods from capturing a window image, but does [b]NOT[/b] guarantee that other apps won't be able to capture an image. It should not be used as a DRM or security measure.
</constant> </constant>