2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								<?xml version="1.0" encoding="UTF-8" ?>  
						 
					
						
							
								
									
										
										
										
											2020-01-31 17:03:48 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								<class  name= "Viewport"  inherits= "Node"  version= "4.0" >  
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									<brief_description > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										Creates a sub-view into the screen.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</brief_description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-30 18:22:57 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										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 Camera3D 3D nodes will render on it too.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports.
							 
						 
					
						
							
								
									
										
										
										
											2020-04-01 15:28:09 -03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										If a viewport is a child of a [SubViewportContainer], it will automatically take up its size, otherwise it must be set manually.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										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 > 
							 
						 
					
						
							
								
									
										
										
										
											2020-08-05 14:43:40 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<link  title= "Viewport and canvas transforms" > https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<link  title= "Viewports tutorial index" > https://docs.godotengine.org/en/latest/tutorials/viewports/index.html</link> 
							 
						 
					
						
							
								
									
										
										
										
											2020-10-01 04:34:47 -04:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<link  title= "GUI in 3D Demo" > https://godotengine.org/asset-library/asset/127</link> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<link  title= "3D in 2D Demo" > https://godotengine.org/asset-library/asset/128</link> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<link  title= "2D in 3D Demo" > https://godotengine.org/asset-library/asset/129</link> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<link  title= "Screen Capture Demo" > https://godotengine.org/asset-library/asset/130</link> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<link  title= "Dynamic Split Screen Demo" > https://godotengine.org/asset-library/asset/541</link> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<link  title= "3D Viewport Scaling Demo" > https://godotengine.org/asset-library/asset/586</link> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</tutorials> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<methods > 
							 
						 
					
						
							
								
									
										
										
										
											2020-05-04 16:55:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "find_world_2d"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "World2D" > 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-05-04 16:55:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the 2D world of the viewport.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2020-05-04 16:55:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "find_world_3d"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "World3D" > 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-05-04 16:55:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the 3D world of the viewport, or if none the world of the parent viewport.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<method  name= "get_camera"  qualifiers= "const" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-30 18:22:57 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<return  type= "Camera3D" > 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2018-08-18 21:29:12 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the active 3D camera.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<method  name= "get_final_transform"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "Transform2D" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2018-08-18 21:29:12 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the total transform of the viewport.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<method  name= "get_mouse_position"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "Vector2" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2018-08-18 21:29:12 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the mouse position relative to the viewport.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<method  name= "get_render_info" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "int" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<argument  index= "0"  name= "info"  type= "int"  enum= "Viewport.RenderInfo" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2018-08-18 21:29:12 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns information about the viewport from the rendering pipeline.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-27 16:10:09 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "get_shadow_atlas_quadrant_subdiv"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "int"  enum= "Viewport.ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<argument  index= "0"  name= "quadrant"  type= "int" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the [enum ShadowAtlasQuadrantSubdiv] of the specified quadrant.
							 
						 
					
						
							
								
									
										
										
										
											2019-06-27 16:10:09 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										<method  name= "get_texture"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "ViewportTexture" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-22 01:04:47 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the viewport's texture.
							 
						 
					
						
							
								
									
										
										
										
											2021-03-28 12:32:17 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												[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:
							 
						 
					
						
							
								
									
										
										
										
											2019-02-22 15:11:32 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												[codeblock]
							 
						 
					
						
							
								
									
										
										
										
											2021-03-28 12:32:17 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												var img = get_viewport().get_texture().get_image()
							 
						 
					
						
							
								
									
										
										
										
											2019-02-22 15:11:32 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												img.flip_y()
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
												[/codeblock]
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<method  name= "get_viewport_rid"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "RID" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-30 18:22:57 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the viewport's RID from the [RenderingServer].
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<method  name= "get_visible_rect"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "Rect2" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2018-08-18 21:29:12 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the visible rectangle in global screen coordinates.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<method  name= "gui_get_drag_data"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "Variant" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2017-10-14 12:45:26 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the drag data from the GUI, that was previously returned by [method Control.get_drag_data].
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2018-08-29 22:25:11 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "gui_is_dragging"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "bool" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2019-11-24 10:45:04 -05:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns [code]true[/code] if the viewport is currently performing a drag operation.
							 
						 
					
						
							
								
									
										
										
										
											2018-08-29 22:25:11 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										<method  name= "input" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "void" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-31 11:56:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<argument  index= "0"  name= "event"  type= "InputEvent" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<argument  index= "1"  name= "in_local_coords"  type= "bool"  default= "false" > 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-31 11:56:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "input_text" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "void" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-11-20 09:34:45 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-31 11:56:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<argument  index= "0"  name= "text"  type= "String" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
									
										
										
										
											2018-11-20 09:34:45 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-31 11:56:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "is_embedding_subwindows"  qualifiers= "const" > 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											<return  type= "bool" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-31 11:56:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "is_input_handled"  qualifiers= "const" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "bool" > 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2018-11-20 09:34:45 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "set_input_as_handled" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "void" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Stops the input from propagating further down the [SceneTree].
							 
						 
					
						
							
								
									
										
										
										
											2018-11-20 09:34:45 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-27 16:10:09 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "set_shadow_atlas_quadrant_subdiv" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "void" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<argument  index= "0"  name= "quadrant"  type= "int" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<argument  index= "1"  name= "subdiv"  type= "int"  enum= "Viewport.ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Sets the number of subdivisions to use in the specified quadrant. A higher number of subdivisions allows you to have more shadows in the scene at once, but reduces the quality of the shadows. A good practice is to have quadrants with a varying number of subdivisions and to have as few subdivisions as possible.
							 
						 
					
						
							
								
									
										
										
										
											2019-06-27 16:10:09 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										<method  name= "unhandled_input" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "void" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-31 11:56:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<argument  index= "0"  name= "event"  type= "InputEvent" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<argument  index= "1"  name= "in_local_coords"  type= "bool"  default= "false" > 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<method  name= "update_worlds" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "void" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2018-08-18 21:29:12 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Forces update of the 2D and 3D worlds.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<method  name= "warp_mouse" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<return  type= "void" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</return> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-10 15:37:49 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<argument  index= "0"  name= "to_position"  type= "Vector2" > 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2018-08-18 21:29:12 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Warps the mouse to a position relative to the viewport.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</methods> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<members > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "audio_listener_enable_2d"  type= "bool"  setter= "set_as_audio_listener_2d"  getter= "is_audio_listener_2d"  default= "false" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 15:24:23 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											If [code]true[/code], the viewport will process 2D audio streams.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "audio_listener_enable_3d"  type= "bool"  setter= "set_as_audio_listener"  getter= "is_audio_listener"  default= "false" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 15:24:23 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											If [code]true[/code], the viewport will process 3D audio streams.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "canvas_item_default_texture_filter"  type= "int"  setter= "set_default_canvas_item_texture_filter"  getter= "get_default_canvas_item_texture_filter"  enum= "Viewport.DefaultCanvasItemTextureFilter"  default= "1" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Sets the default filter mode used by [CanvasItem]s in this Viewport. See [enum DefaultCanvasItemTextureFilter] for options.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<member  name= "canvas_item_default_texture_repeat"  type= "int"  setter= "set_default_canvas_item_texture_repeat"  getter= "get_default_canvas_item_texture_repeat"  enum= "Viewport.DefaultCanvasItemTextureRepeat"  default= "0" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Sets the default repeat mode used by [CanvasItem]s in this Viewport. See [enum DefaultCanvasItemTextureRepeat] for options.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 21:22:15 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "canvas_transform"  type= "Transform2D"  setter= "set_canvas_transform"  getter= "get_canvas_transform" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-12 00:38:35 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											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> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "debug_draw"  type= "int"  setter= "set_debug_draw"  getter= "get_debug_draw"  enum= "Viewport.DebugDraw"  default= "0" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 15:24:23 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The overlay mode for test rendered geometry in debug purposes.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 21:22:15 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "global_canvas_transform"  type= "Transform2D"  setter= "set_global_canvas_transform"  getter= "get_global_canvas_transform" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-12 00:38:35 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The global canvas transform of the viewport. The canvas transform is relative to this.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "gui_disable_input"  type= "bool"  setter= "set_disable_input"  getter= "is_input_disabled"  default= "false" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-12-28 13:36:31 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											If [code]true[/code], the viewport will not receive input events.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-31 11:56:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "gui_embed_subwindows"  type= "bool"  setter= "set_embed_subwindows_hint"  getter= "get_embed_subwindows_hint"  default= "false" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "gui_snap_controls_to_pixels"  type= "bool"  setter= "set_snap_controls_to_pixels"  getter= "is_snap_controls_to_pixels_enabled"  default= "true" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 15:24:23 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											If [code]true[/code], the GUI controls on the viewport will lay pixel perfectly.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "handle_input_locally"  type= "bool"  setter= "set_handle_input_locally"  getter= "is_handling_input_locally"  default= "true" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-11-20 09:34:45 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2021-01-04 14:33:44 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "lod_threshold"  type= "float"  setter= "set_lod_threshold"  getter= "get_lod_threshold"  default= "1.0" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "msaa"  type= "int"  setter= "set_msaa"  getter= "get_msaa"  enum= "Viewport.MSAA"  default= "0" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-28 10:58:48 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The multisample anti-aliasing mode. A higher number results in smoother edges at the cost of significantly worse performance. A value of 4 is best unless targeting very high-end systems.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2020-05-04 16:55:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "own_world_3d"  type= "bool"  setter= "set_use_own_world_3d"  getter= "is_using_own_world_3d"  default= "false" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											If [code]true[/code], the viewport will use the [World3D] defined in [member world_3d].
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "physics_object_picking"  type= "bool"  setter= "set_physics_object_picking"  getter= "get_physics_object_picking"  default= "false" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 15:24:23 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											If [code]true[/code], the objects rendered by viewport become subjects of mouse picking process.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "screen_space_aa"  type= "int"  setter= "set_screen_space_aa"  getter= "get_screen_space_aa"  enum= "Viewport.ScreenSpaceAA"  default= "0" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Sets the screen-space antialiasing method used. Screen-space antialiasing works by selectively blurring edges in a post-process shader. It differs from MSAA which takes multiple coverage samples while rendering objects. Screen-space AA methods are typically faster than MSAA and will smooth out specular aliasing, but tend to make scenes appear blurry.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2020-12-04 15:54:48 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "sdf_oversize"  type= "int"  setter= "set_sdf_oversize"  getter= "get_sdf_oversize"  enum= "Viewport.SDFOversize"  default= "1" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<member  name= "sdf_scale"  type= "int"  setter= "set_sdf_scale"  getter= "get_sdf_scale"  enum= "Viewport.SDFScale"  default= "1" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2021-01-28 11:26:37 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "shadow_atlas_16_bits"  type= "bool"  setter= "set_shadow_atlas_16_bits"  getter= "get_shadow_atlas_16_bits"  default= "true" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "shadow_atlas_quad_0"  type= "int"  setter= "set_shadow_atlas_quadrant_subdiv"  getter= "get_shadow_atlas_quadrant_subdiv"  enum= "Viewport.ShadowAtlasQuadrantSubdiv"  default= "2" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The subdivision amount of the first quadrant on the shadow atlas.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "shadow_atlas_quad_1"  type= "int"  setter= "set_shadow_atlas_quadrant_subdiv"  getter= "get_shadow_atlas_quadrant_subdiv"  enum= "Viewport.ShadowAtlasQuadrantSubdiv"  default= "2" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The subdivision amount of the second quadrant on the shadow atlas.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "shadow_atlas_quad_2"  type= "int"  setter= "set_shadow_atlas_quadrant_subdiv"  getter= "get_shadow_atlas_quadrant_subdiv"  enum= "Viewport.ShadowAtlasQuadrantSubdiv"  default= "3" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The subdivision amount of the third quadrant on the shadow atlas.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "shadow_atlas_quad_3"  type= "int"  setter= "set_shadow_atlas_quadrant_subdiv"  getter= "get_shadow_atlas_quadrant_subdiv"  enum= "Viewport.ShadowAtlasQuadrantSubdiv"  default= "4" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The subdivision amount of the fourth quadrant on the shadow atlas.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2021-01-28 11:26:37 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "shadow_atlas_size"  type= "int"  setter= "set_shadow_atlas_size"  getter= "get_shadow_atlas_size"  default= "2048" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-09-04 23:32:46 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The shadow atlas' resolution (used for omni and spot lights). The value will be rounded up to the nearest power of 2.
							 
						 
					
						
							
								
									
										
										
										
											2021-01-28 11:26:37 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											[b]Note:[/b] If this is set to 0, shadows won't be visible.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2020-11-04 15:38:26 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "snap_2d_transforms_to_pixel"  type= "bool"  setter= "set_snap_2d_transforms_to_pixel"  getter= "is_snap_2d_transforms_to_pixel_enabled"  default= "false" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<member  name= "snap_2d_vertices_to_pixel"  type= "bool"  setter= "set_snap_2d_vertices_to_pixel"  getter= "is_snap_2d_vertices_to_pixel_enabled"  default= "false" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "transparent_bg"  type= "bool"  setter= "set_transparent_background"  getter= "has_transparent_background"  default= "false" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 15:24:23 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											If [code]true[/code], the viewport should render its background as transparent.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2020-11-04 15:38:26 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "use_debanding"  type= "bool"  setter= "set_use_debanding"  getter= "is_using_debanding"  default= "false" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2021-04-20 18:40:24 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "use_occlusion_culling"  type= "bool"  setter= "set_use_occlusion_culling"  getter= "is_using_occlusion_culling"  default= "false" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 21:22:15 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "world_2d"  type= "World2D"  setter= "set_world_2d"  getter= "get_world_2d" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-30 17:50:25 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The custom [World2D] which can be used as 2D environment source.
							 
						 
					
						
							
								
									
										
										
										
											2018-01-12 00:38:35 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2020-05-04 16:55:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "world_3d"  type= "World3D"  setter= "set_world_3d"  getter= "get_world_3d" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											The custom [World3D] which can be used as 3D environment source.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</members> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<signals > 
							 
						 
					
						
							
								
									
										
										
										
											2019-12-11 14:29:36 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<signal  name= "gui_focus_changed" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-12-17 11:43:07 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<argument  index= "0"  name= "node"  type= "Control" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-12-11 14:29:36 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											</argument> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
												Emitted when a Control node grabs keyboard focus.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</signal> 
							 
						 
					
						
							
								
									
										
										
										
											2019-12-17 11:43:07 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<signal  name= "size_changed" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-03-31 11:56:58 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Emitted when the size of the viewport is changed, whether by resizing of window, or some other means.
							 
						 
					
						
							
								
									
										
										
										
											2019-12-17 11:43:07 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</signal> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</signals> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<constants > 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "SHADOW_ATLAS_QUADRANT_SUBDIV_DISABLED"  value= "0"  enum= "ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											This quadrant will not be used.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "SHADOW_ATLAS_QUADRANT_SUBDIV_1"  value= "1"  enum= "ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											This quadrant will only be used by one shadow map.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "SHADOW_ATLAS_QUADRANT_SUBDIV_4"  value= "2"  enum= "ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											This quadrant will be split in 4 and used by up to 4 shadow maps.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "SHADOW_ATLAS_QUADRANT_SUBDIV_16"  value= "3"  enum= "ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											This quadrant will be split 16 ways and used by up to 16 shadow maps.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "SHADOW_ATLAS_QUADRANT_SUBDIV_64"  value= "4"  enum= "ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											This quadrant will be split 64 ways and used by up to 64 shadow maps.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "SHADOW_ATLAS_QUADRANT_SUBDIV_256"  value= "5"  enum= "ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											This quadrant will be split 256 ways and used by up to 256 shadow maps. Unless the [member shadow_atlas_size] is very high, the shadows in this quadrant will be very low resolution.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "SHADOW_ATLAS_QUADRANT_SUBDIV_1024"  value= "6"  enum= "ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-25 21:59:51 -08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											This quadrant will be split 1024 ways and used by up to 1024 shadow maps. Unless the [member shadow_atlas_size] is very high, the shadows in this quadrant will be very low resolution.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "SHADOW_ATLAS_QUADRANT_SUBDIV_MAX"  value= "7"  enum= "ShadowAtlasQuadrantSubdiv" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-27 11:10:53 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Represents the size of the [enum ShadowAtlasQuadrantSubdiv] enum.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-20 11:48:00 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "MSAA_DISABLED"  value= "0"  enum= "MSAA" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Multisample antialiasing mode disabled. This is the default value, and also the fastest setting.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "MSAA_2X"  value= "1"  enum= "MSAA" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Use 2x Multisample Antialiasing.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "MSAA_4X"  value= "2"  enum= "MSAA" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Use 4x Multisample Antialiasing.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "MSAA_8X"  value= "3"  enum= "MSAA" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Use 8x Multisample Antialiasing. Likely unsupported on low-end and older hardware.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "MSAA_16X"  value= "4"  enum= "MSAA" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Use 16x Multisample Antialiasing. Likely unsupported on medium and low-end hardware.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "MSAA_MAX"  value= "5"  enum= "MSAA" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Represents the size of the [enum MSAA] enum.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SCREEN_SPACE_AA_DISABLED"  value= "0"  enum= "ScreenSpaceAA" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Do not perform any antialiasing in the full screen post-process.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SCREEN_SPACE_AA_FXAA"  value= "1"  enum= "ScreenSpaceAA" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-07-16 12:54:15 -04:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Use fast approximate antialiasing. FXAA is a popular screen-space antialiasing method, which is fast but will make the image look blurry, especially at lower resolutions. It can still work relatively well at large resolutions such as 1440p and 4K.
							 
						 
					
						
							
								
									
										
										
										
											2020-04-20 11:48:00 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SCREEN_SPACE_AA_MAX"  value= "2"  enum= "ScreenSpaceAA" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Represents the size of the [enum ScreenSpaceAA] enum.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "RENDER_INFO_OBJECTS_IN_FRAME"  value= "0"  enum= "RenderInfo" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-30 17:50:25 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Amount of objects in frame.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "RENDER_INFO_VERTICES_IN_FRAME"  value= "1"  enum= "RenderInfo" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-02-19 10:47:16 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Amount of vertices in frame.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "RENDER_INFO_MATERIAL_CHANGES_IN_FRAME"  value= "2"  enum= "RenderInfo" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-30 17:50:25 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Amount of material changes in frame.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "RENDER_INFO_SHADER_CHANGES_IN_FRAME"  value= "3"  enum= "RenderInfo" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-30 17:50:25 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Amount of shader changes in frame.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "RENDER_INFO_SURFACE_CHANGES_IN_FRAME"  value= "4"  enum= "RenderInfo" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-30 17:50:25 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Amount of surface changes in frame.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "RENDER_INFO_DRAW_CALLS_IN_FRAME"  value= "5"  enum= "RenderInfo" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-30 17:50:25 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Amount of draw calls in frame.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "RENDER_INFO_MAX"  value= "6"  enum= "RenderInfo" > 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-27 11:10:53 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Represents the size of the [enum RenderInfo] enum.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_DISABLED"  value= "0"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-30 17:50:25 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Objects are displayed normally.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-11-24 23:16:30 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_UNSHADED"  value= "1"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-30 17:50:25 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Objects are displayed without light information.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-20 11:48:00 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_LIGHTING"  value= "2"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_OVERDRAW"  value= "3"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Objects are displayed semi-transparent with additive blending so you can see where they are drawing over top of one another. A higher overdraw means you are wasting performance on drawing pixels that are being hidden behind others.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_WIREFRAME"  value= "4"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-30 17:50:25 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Objects are displayed in wireframe style.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-20 11:48:00 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_NORMAL_BUFFER"  value= "5"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_GI_PROBE_ALBEDO"  value= "6"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Objects are displayed with only the albedo value from [GIProbe]s.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_GI_PROBE_LIGHTING"  value= "7"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Objects are displayed with only the lighting value from [GIProbe]s.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_GI_PROBE_EMISSION"  value= "8"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Objects are displayed with only the emission color from [GIProbe]s.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_SHADOW_ATLAS"  value= "9"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Draws the shadow atlas that stores shadows from [OmniLight3D]s and [SpotLight3D]s in the upper left quadrant of the [Viewport].
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS"  value= "10"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Draws the shadow atlas that stores shadows from [DirectionalLight3D]s in the upper left quadrant of the [Viewport].
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_SCENE_LUMINANCE"  value= "11"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_SSAO"  value= "12"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Draws the screen-space ambient occlusion texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have [member Environment.ssao_enabled] set in your [WorldEnvironment].
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-07-01 14:18:13 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_PSSM_SPLITS"  value= "13"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Colors each PSSM split for the [DirectionalLight3D]s in the scene a different color so you can see where the splits are. In order, they will be colored red, green, blue, and yellow.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-07-01 14:18:13 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_DECAL_ATLAS"  value= "14"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Draws the decal atlas used by [Decal]s and light projector textures in the upper left quadrant of the [Viewport].
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-07-01 14:18:13 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_SDFGI"  value= "15"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_SDFGI_PROBES"  value= "16"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_GI_BUFFER"  value= "17"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2021-01-04 14:33:44 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_DISABLE_LOD"  value= "18"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2021-01-28 11:26:37 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_CLUSTER_OMNI_LIGHTS"  value= "19"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_CLUSTER_SPOT_LIGHTS"  value= "20"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_CLUSTER_DECALS"  value= "21"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_CLUSTER_REFLECTION_PROBES"  value= "22"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2021-04-20 18:40:24 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEBUG_DRAW_OCCLUDERS"  value= "23"  enum= "DebugDraw" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST"  value= "0"  enum= "DefaultCanvasItemTextureFilter" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR"  value= "1"  enum= "DefaultCanvasItemTextureFilter" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS"  value= "2"  enum= "DefaultCanvasItemTextureFilter" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-20 01:31:43 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS"  value= "3"  enum= "DefaultCanvasItemTextureFilter" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_MAX"  value= "4"  enum= "DefaultCanvasItemTextureFilter" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Max value for [enum DefaultCanvasItemTextureFilter] enum.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED"  value= "0"  enum= "DefaultCanvasItemTextureRepeat" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Disables textures repeating. Instead, when reading UVs outside the 0-1 range, the value will be clamped to the edge of the texture, resulting in a stretched out look at the borders of the texture.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED"  value= "1"  enum= "DefaultCanvasItemTextureRepeat" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Enables the texture to repeat when UV coordinates are outside the 0-1 range. If using one of the linear filtering modes, this can result in artifacts at the edges of a texture when the sampler filters across the edges of the texture.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR"  value= "2"  enum= "DefaultCanvasItemTextureRepeat" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Flip the texture when repeating so that the edge lines up instead of abruptly changing.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "DEFAULT_CANVAS_ITEM_TEXTURE_REPEAT_MAX"  value= "3"  enum= "DefaultCanvasItemTextureRepeat" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-04-16 16:05:25 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Max value for [enum DefaultCanvasItemTextureRepeat] enum.
							 
						 
					
						
							
								
									
										
										
										
											2020-02-12 09:59:06 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2020-12-04 15:54:48 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<constant  name= "SDF_OVERSIZE_100_PERCENT"  value= "0"  enum= "SDFOversize" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SDF_OVERSIZE_120_PERCENT"  value= "1"  enum= "SDFOversize" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SDF_OVERSIZE_150_PERCENT"  value= "2"  enum= "SDFOversize" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SDF_OVERSIZE_200_PERCENT"  value= "3"  enum= "SDFOversize" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SDF_OVERSIZE_MAX"  value= "4"  enum= "SDFOversize" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SDF_SCALE_100_PERCENT"  value= "0"  enum= "SDFScale" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SDF_SCALE_50_PERCENT"  value= "1"  enum= "SDFScale" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SDF_SCALE_25_PERCENT"  value= "2"  enum= "SDFScale" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<constant  name= "SDF_SCALE_MAX"  value= "3"  enum= "SDFScale" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</constant> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</constants> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								</class>