diff options
| author | kobewi <kobewi4e@gmail.com> | 2022-05-04 02:11:07 +0200 |
|---|---|---|
| committer | kobewi <kobewi4e@gmail.com> | 2022-05-04 02:30:32 +0200 |
| commit | 708a3b3db82650a9657d0f8f7c2e4d4fb02ca32e (patch) | |
| tree | 27c2f18f7ca2cb1f0e04cc7b05d543ba451e16f6 /doc | |
| parent | 1b2992799b324479b3fba9e05ae6226a46cb4143 (diff) | |
Improve Viewport.get_texture() description
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Viewport.xml | 17 |
1 files changed, 6 insertions, 11 deletions
diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index ce466b2d0f..148c6d7064 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -75,17 +75,12 @@ <return type="ViewportTexture" /> <description> Returns the viewport's texture. - [b]Note:[/b] Due to the way OpenGL works, the resulting [ViewportTexture] is flipped vertically. You can use [method Image.flip_y] on the result of [method Texture2D.get_image] to flip it back, for example: - [codeblocks] - [gdscript] - var img = get_viewport().get_texture().get_image() - img.flip_y() - [/gdscript] - [csharp] - Image img = GetViewport().GetTexture().GetImage(); - img.FlipY(); - [/csharp] - [/codeblocks] + [b]Note:[/b] When trying to store the current texture (e.g. in a file), it might be completely black or outdated if used too early, especially when used in e.g. [method Node._ready]. To make sure the texture you get is correct, you can await [signal RenderingServer.frame_post_draw] signal. + [codeblock] + func _ready(): + await RenderingServer.frame_post_draw + $Viewport.get_texture().get_image().save_png("user://Screenshot.png") + [/codeblock] </description> </method> <method name="get_viewport_rid" qualifiers="const"> |