Andrew/redot-engine
1
0
Fork 0
mirror of https://github.com/Redot-Engine/redot-engine.git synced 2025-12-05 23:07:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #109010 from LurkerAbove/viewport-gettexture-docs-add-cscode

Browse Source 
Add the C# code equivalent to the documentation of Viewport.GetTexture()
This commit is contained in:
Thaddeus Crews
2025-08-18 20:36:48 -05:00
parent 4d107c1f56 0ea06fe446
commit 3d87dcbd64
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/classes/Viewport.xml
View File

@@ -122,11 +122,21 @@
<description>
Returns the viewport's texture.
[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]
[codeblocks]
[gdscript]
func _ready():
await RenderingServer.frame_post_draw
$Viewport.get_texture().get_image().save_png("user://Screenshot.png")
[/codeblock]
await RenderingServer.frame_post_draw
$Viewport.get_texture().get_image().save_png("user://Screenshot.png")
[/gdscript]
[csharp]
public async override void _Ready()
{
await ToSignal(RenderingServer.Singleton, RenderingServer.SignalName.FramePostDraw);
var viewport = GetNode&lt;Viewport&gt;("Viewport");
viewport.GetTexture().GetImage().SavePng("user://Screenshot.png");
}
[/csharp]
[/codeblocks]
[b]Note:[/b] When [member use_hdr_2d] is [code]true[/code] the returned texture will be an HDR image encoded in linear space.
</description>
</method>