From aad9cd3e2254dd92bc31aa2997c28764c66e83a0 Mon Sep 17 00:00:00 2001 From: Bojidar Marinov Date: Sun, 5 Jun 2016 14:51:44 +0300 Subject: [PATCH] Document Viewport and ViewportSprite classes (cherry picked from commit 662e0cc4115be65de3ca7a59c78454f97918dce3) --- doc/base/classes.xml | 61 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 32eb59096e3..d6cf4306c35 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -40471,54 +40471,63 @@ This method controls whether the position between two cached points is interpola + Return the 2D world of the viewport. + Change the 3D world of the viewport. + Return the 3D world of the viewport. + Return the 3D world of the viewport, or if no such present, the one of the parent viewport. + Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. + Get the canvas transform of the viewport. + Set the global canvas transform of the viewport. The canvas transform is relative to this. + Get the global canvas transform of the viewport. + Get the total transform of the viewport. @@ -40550,134 +40559,157 @@ This method controls whether the position between two cached points is interpola + Set the size of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. + Get the size override set with [method set_size_override]. + Get the enabled status of the size override set with [method set_size_override]. + Set whether the size override affects stretch as well. + Get the enabled status of the size strech override set with [method set_size_override_stretch]. + Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture]. + Return the captured screenshot after [method queue_screen_capture]. You might need to check more than one frame untill the right image is returned. + Set the viewport's render target mode. + Return whether the viewport is set as a render target by [method set_as_render_target]. + Set whether the render target should be flipped on the Y axis. + Set whether the render target is flipped on the Y axis. + Enable/disable automatic clearing of the render target on each frame. You might find it better to disable this if you are using the viewport for rarely updated textures. To clear manually, check [method render_target_clear] + Return whether automatic clearing of the render target on each frame is enabled. + Clear the render target manually. + Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible. + Get whether the rendered texture has filters enabled. + Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away. + Get whether the rendered texture will have mipmaps generated. + Set when the render target should be updated, has to be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. + Get when the render target would be updated, will be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. + Get the render target's texture, for use with various objects that you want to texture with the viewport. + Enable/disable picking for all physics objects inside the viewport. + Get whether picking for all physics objects inside the viewport is enabled. @@ -40701,156 +40733,185 @@ This method controls whether the position between two cached points is interpola + Force update of the 2D and 3D worlds. + Make the viewport use a world separate from the parent viewport's world. + Return whether the viewport is using a world separate from the parent viewport's world. + Return the active 3D camera. + Makes the viewport send sounds to the speakers. + Returns whether the viewport sends sounds to the speakers. + Makes the viewport send sounds from 2D emitters to the speakers. + Returns whether the viewport sends soundsfrom 2D emitters to the speakers. + Map a part of the screen to the render target directly. + Get the mouse position, relative to the viewport. + Wrap the mouse to a position, relative to the viewport. + Returs whether there are shown modals on-screen. + Set whether input to the viewport is disabled. + Return whether input to the viewport is disabled. + Emitted when the size of the viewport is changed, whether by [method set_size_override], resize of window, or some other means. + Do not update the render target. + Update the render target once, then switch to [code]RENDER_TARGET_UPDATE_DISABLED[/code] + Update the render target only when it is visible. This is the default value. + Update the render target always. + Displays a viewport as a sprite. + Used to display a [Viewport] node at some position in the world, without having to mess with [RenderTargetTexture]s. + Set the path to the shown [Viewport] node. + Return the path to the shown [Viewport] node. + Set whether the viewport's texture should be centered on the origin. + Return whether the viewport's texture is centered on the origin. + Set the offset to the origin of the texture. + get the offset to the origin of the texture. + Set color modulation for the texture. All texture pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. + Get color modulation for the texture. All texture pixels are multiplied by this color.