path: root/doc/classes/Viewport.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Viewport" inherits="Node" category="Core" version="3.2">
	<brief_description>
		Creates a sub-view into the screen.
	</brief_description>
	<description>
		A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will render on it too.
		Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports.
		If a viewport is a child of a [ViewportContainer], it will automatically take up its size, otherwise it must be set manually.
		Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it.
		Also, viewports can be assigned to different screens in case the devices have multiple screens.
		Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw.
	</description>
	<tutorials>
		<link>https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link>
		<link>https://docs.godotengine.org/en/latest/tutorials/viewports/index.html</link>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="find_world" qualifiers="const">
			<return type="World">
			</return>
			<description>
				Returns the 3D world of the viewport, or if none the world of the parent viewport.
			</description>
		</method>
		<method name="find_world_2d" qualifiers="const">
			<return type="World2D">
			</return>
			<description>
				Returns the 2D world of the viewport.
			</description>
		</method>
		<method name="get_camera" qualifiers="const">
			<return type="Camera">
			</return>
			<description>
				Returns the active 3D camera.
			</description>
		</method>
		<method name="get_final_transform" qualifiers="const">
			<return type="Transform2D">
			</return>
			<description>
				Returns the total transform of the viewport.
			</description>
		</method>
		<method name="get_modal_stack_top" qualifiers="const">
			<return type="Control">
			</return>
			<description>
				Returns the topmost modal in the stack.
			</description>
		</method>
		<method name="get_mouse_position" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Returns the mouse position relative to the viewport.
			</description>
		</method>
		<method name="get_render_info">
			<return type="int">
			</return>
			<argument index="0" name="info" type="int" enum="Viewport.RenderInfo">
			</argument>
			<description>
				Returns information about the viewport from the rendering pipeline.
			</description>
		</method>
		<method name="get_size_override" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Returns the size override set with [method set_size_override].
			</description>
		</method>
		<method name="get_texture" qualifiers="const">
			<return type="ViewportTexture">
			</return>
			<description>
				Returns the viewport's texture. Note that due to the way OpenGL works, the resulting [ViewportTexture] is flipped vertically. You can use [method Image.flip_y] on the result of [method Texture.get_data] to flip it back, for example:
				[codeblock]
				var img = get_viewport().get_texture().get_data()
				img.flip_y()
				[/codeblock]
			</description>
		</method>
		<method name="get_viewport_rid" qualifiers="const">
			<return type="RID">
			</return>
			<description>
				Returns the viewport's RID from the [VisualServer].
			</description>
		</method>
		<method name="get_visible_rect" qualifiers="const">
			<return type="Rect2">
			</return>
			<description>
				Returns the visible rectangle in global screen coordinates.
			</description>
		</method>
		<method name="gui_get_drag_data" qualifiers="const">
			<return type="Variant">
			</return>
			<description>
				Returns the drag data from the GUI, that was previously returned by [method Control.get_drag_data].
			</description>
		</method>
		<method name="gui_has_modal_stack" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if there are visible modals on-screen.
			</description>
		</method>
		<method name="gui_is_dragging" qualifiers="const">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="input">
			<return type="void">
			</return>
			<argument index="0" name="local_event" type="InputEvent">
			</argument>
			<description>
			</description>
		</method>
		<method name="is_input_handled" qualifiers="const">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="is_size_override_enabled" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if the size override is enabled. See [method set_size_override].
			</description>
		</method>
		<method name="is_size_override_stretch_enabled" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if the size stretch override is enabled. See [method set_size_override_stretch].
			</description>
		</method>
		<method name="set_attach_to_screen_rect">
			<return type="void">
			</return>
			<argument index="0" name="rect" type="Rect2">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_input_as_handled">
			<return type="void">
			</return>
			<description>
			</description>
		</method>
		<method name="set_size_override">
			<return type="void">
			</return>
			<argument index="0" name="enable" type="bool">
			</argument>
			<argument index="1" name="size" type="Vector2" default="Vector2( -1, -1 )">
			</argument>
			<argument index="2" name="margin" type="Vector2" default="Vector2( 0, 0 )">
			</argument>
			<description>
				Sets the size override of the viewport. If the [code]enable[/code] parameter is [code]true[/code] the override is used, otherwise it uses the default size. If the size parameter is [code](-1, -1)[/code], it won't update the size.
			</description>
		</method>
		<method name="set_size_override_stretch">
			<return type="void">
			</return>
			<argument index="0" name="enabled" type="bool">
			</argument>
			<description>
				If [code]true[/code], the size override affects stretch as well.
			</description>
		</method>
		<method name="unhandled_input">
			<return type="void">
			</return>
			<argument index="0" name="local_event" type="InputEvent">
			</argument>
			<description>
			</description>
		</method>
		<method name="update_worlds">
			<return type="void">
			</return>
			<description>
				Forces update of the 2D and 3D worlds.
			</description>
		</method>
		<method name="warp_mouse">
			<return type="void">
			</return>
			<argument index="0" name="to_position" type="Vector2">
			</argument>
			<description>
				Warps the mouse to a position relative to the viewport.
			</description>
		</method>
	</methods>
	<members>
		<member name="arvr" type="bool" setter="set_use_arvr" getter="use_arvr">
			If [code]true[/code], the viewport will be used in AR/VR process. Default value: [code]false[/code].
		</member>
		<member name="audio_listener_enable_2d" type="bool" setter="set_as_audio_listener_2d" getter="is_audio_listener_2d">
			If [code]true[/code], the viewport will process 2D audio streams. Default value: [code]false[/code].
		</member>
		<member name="audio_listener_enable_3d" type="bool" setter="set_as_audio_listener" getter="is_audio_listener">
			If [code]true[/code], the viewport will process 3D audio streams. Default value: [code]false[/code].
		</member>
		<member name="canvas_transform" type="Transform2D" setter="set_canvas_transform" getter="get_canvas_transform">
			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.
		</member>
		<member name="debug_draw" type="int" setter="set_debug_draw" getter="get_debug_draw" enum="Viewport.DebugDraw">
			The overlay mode for test rendered geometry in debug purposes. Default value: [code]DEBUG_DRAW_DISABLED[/code].
		</member>
		<member name="disable_3d" type="bool" setter="set_disable_3d" getter="is_3d_disabled">
			If [code]true[/code], the viewport will disable 3D rendering. For actual disabling use [code]usage[/code]. Default value: [code]false[/code].
		</member>
		<member name="global_canvas_transform" type="Transform2D" setter="set_global_canvas_transform" getter="get_global_canvas_transform">
			The global canvas transform of the viewport. The canvas transform is relative to this.
		</member>
		<member name="gui_disable_input" type="bool" setter="set_disable_input" getter="is_input_disabled">
			If [code]true[/code], the viewport will not receive input event. Default value: [code]false[/code].
		</member>
		<member name="gui_snap_controls_to_pixels" type="bool" setter="set_snap_controls_to_pixels" getter="is_snap_controls_to_pixels_enabled">
			If [code]true[/code], the GUI controls on the viewport will lay pixel perfectly. Default value: [code]true[/code].
		</member>
		<member name="handle_input_locally" type="bool" setter="set_handle_input_locally" getter="is_handling_input_locally">
		</member>
		<member name="hdr" type="bool" setter="set_hdr" getter="get_hdr">
			If [code]true[/code], the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: [code]true[/code].
		</member>
		<member name="keep_3d_linear" type="bool" setter="set_keep_3d_linear" getter="get_keep_3d_linear">
			If [code]true[/code], the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output.
		</member>
		<member name="msaa" type="int" setter="set_msaa" getter="get_msaa" enum="Viewport.MSAA">
			The multisample anti-aliasing mode. Default value: [code]MSAA_DISABLED[/code].
		</member>
		<member name="own_world" type="bool" setter="set_use_own_world" getter="is_using_own_world">
			If [code]true[/code], the viewport will use [World] defined in [code]world[/code] property. Default value: [code]false[/code].
		</member>
		<member name="physics_object_picking" type="bool" setter="set_physics_object_picking" getter="get_physics_object_picking">
			If [code]true[/code], the objects rendered by viewport become subjects of mouse picking process. Default value: [code]false[/code].
		</member>
		<member name="render_target_clear_mode" type="int" setter="set_clear_mode" getter="get_clear_mode" enum="Viewport.ClearMode">
			The clear mode when viewport used as a render target. Default value: [code]CLEAR_MODE_ALWAYS[/code].
		</member>
		<member name="render_target_update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="Viewport.UpdateMode">
			The update mode when viewport used as a render target. Default value: [code]UPDATE_WHEN_VISIBLE[/code].
		</member>
		<member name="render_target_v_flip" type="bool" setter="set_vflip" getter="get_vflip">
			If [code]true[/code], the result of rendering will be flipped vertically. Default value: [code]false[/code].
		</member>
		<member name="shadow_atlas_quad_0" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv">
			The subdivision amount of first quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_4[/code].
		</member>
		<member name="shadow_atlas_quad_1" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv">
			The subdivision amount of second quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_4[/code].
		</member>
		<member name="shadow_atlas_quad_2" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv">
			The subdivision amount of third quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_16[/code].
		</member>
		<member name="shadow_atlas_quad_3" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv">
			The subdivision amount of fourth quadrant on shadow atlas. Default value: [code]SHADOW_ATLAS_QUADRANT_SUBDIV_64[/code].
		</member>
		<member name="shadow_atlas_size" type="int" setter="set_shadow_atlas_size" getter="get_shadow_atlas_size">
			The resolution of shadow atlas. Both width and height is equal to one value.
		</member>
		<member name="size" type="Vector2" setter="set_size" getter="get_size">
			The width and height of viewport.
		</member>
		<member name="transparent_bg" type="bool" setter="set_transparent_background" getter="has_transparent_background">
			If [code]true[/code], the viewport should render its background as transparent. Default value: [code]false[/code].
		</member>
		<member name="usage" type="int" setter="set_usage" getter="get_usage" enum="Viewport.Usage">
			The rendering mode of viewport. Default value: [code]USAGE_3D[/code].
		</member>
		<member name="world" type="World" setter="set_world" getter="get_world">
			The custom [World] which can be used as 3D environment source.
		</member>
		<member name="world_2d" type="World2D" setter="set_world_2d" getter="get_world_2d">
			The custom [World2D] which can be used as 2D environment source.
		</member>
	</members>
	<signals>
		<signal name="size_changed">
			<description>
				Emitted when the size of the viewport is changed, whether by [method set_size_override], resize of window, or some other means.
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="UPDATE_DISABLED" value="0" enum="UpdateMode">
			Do not update the render target.
		</constant>
		<constant name="UPDATE_ONCE" value="1" enum="UpdateMode">
			Update the render target once, then switch to [code]UPDATE_DISABLED[/code].
		</constant>
		<constant name="UPDATE_WHEN_VISIBLE" value="2" enum="UpdateMode">
			Update the render target only when it is visible. This is the default value.
		</constant>
		<constant name="UPDATE_ALWAYS" value="3" enum="UpdateMode">
			Always update the render target.
		</constant>
		<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED" value="0" enum="ShadowAtlasQuadrantSubdiv">
		</constant>
		<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1" value="1" enum="ShadowAtlasQuadrantSubdiv">
		</constant>
		<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_4" value="2" enum="ShadowAtlasQuadrantSubdiv">
		</constant>
		<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_16" value="3" enum="ShadowAtlasQuadrantSubdiv">
		</constant>
		<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_64" value="4" enum="ShadowAtlasQuadrantSubdiv">
		</constant>
		<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_256" value="5" enum="ShadowAtlasQuadrantSubdiv">
		</constant>
		<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1024" value="6" enum="ShadowAtlasQuadrantSubdiv">
		</constant>
		<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_MAX" value="7" enum="ShadowAtlasQuadrantSubdiv">
			Enum limiter. Do not use it directly.
		</constant>
		<constant name="RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="RenderInfo">
			Amount of objects in frame.
		</constant>
		<constant name="RENDER_INFO_VERTICES_IN_FRAME" value="1" enum="RenderInfo">
			Amount of vertices in frame.
		</constant>
		<constant name="RENDER_INFO_MATERIAL_CHANGES_IN_FRAME" value="2" enum="RenderInfo">
			Amount of material changes in frame.
		</constant>
		<constant name="RENDER_INFO_SHADER_CHANGES_IN_FRAME" value="3" enum="RenderInfo">
			Amount of shader changes in frame.
		</constant>
		<constant name="RENDER_INFO_SURFACE_CHANGES_IN_FRAME" value="4" enum="RenderInfo">
			Amount of surface changes in frame.
		</constant>
		<constant name="RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5" enum="RenderInfo">
			Amount of draw calls in frame.
		</constant>
		<constant name="RENDER_INFO_MAX" value="6" enum="RenderInfo">
			Enum limiter. Do not use it directly.
		</constant>
		<constant name="DEBUG_DRAW_DISABLED" value="0" enum="DebugDraw">
			Objects are displayed normally.
		</constant>
		<constant name="DEBUG_DRAW_UNSHADED" value="1" enum="DebugDraw">
			Objects are displayed without light information.
		</constant>
		<constant name="DEBUG_DRAW_OVERDRAW" value="2" enum="DebugDraw">
			Objected are displayed semi-transparent with additive blending so you can see where they intersect.
		</constant>
		<constant name="DEBUG_DRAW_WIREFRAME" value="3" enum="DebugDraw">
			Objects are displayed in wireframe style.
		</constant>
		<constant name="MSAA_DISABLED" value="0" enum="MSAA">
			Multisample anti-aliasing mode disabled. This is the default value.
		</constant>
		<constant name="MSAA_2X" value="1" enum="MSAA">
		</constant>
		<constant name="MSAA_4X" value="2" enum="MSAA">
		</constant>
		<constant name="MSAA_8X" value="3" enum="MSAA">
		</constant>
		<constant name="MSAA_16X" value="4" enum="MSAA">
		</constant>
		<constant name="USAGE_2D" value="0" enum="Usage">
		</constant>
		<constant name="USAGE_2D_NO_SAMPLING" value="1" enum="Usage">
		</constant>
		<constant name="USAGE_3D" value="2" enum="Usage">
		</constant>
		<constant name="USAGE_3D_NO_EFFECTS" value="3" enum="Usage">
		</constant>
		<constant name="CLEAR_MODE_ALWAYS" value="0" enum="ClearMode">
			Always clear the render target before drawing.
		</constant>
		<constant name="CLEAR_MODE_NEVER" value="1" enum="ClearMode">
			Never clear the render target.
		</constant>
		<constant name="CLEAR_MODE_ONLY_NEXT_FRAME" value="2" enum="ClearMode">
			Clear the render target next frame, then switch to [code]CLEAR_MODE_NEVER[/code].
		</constant>
	</constants>
</class>