|
@@ -747,24 +747,6 @@ Signals
|
|
|
Enumerations
|
|
|
------------
|
|
|
|
|
|
-.. _enum_VisualServer_ViewportRenderInfo:
|
|
|
-
|
|
|
-enum **ViewportRenderInfo**:
|
|
|
-
|
|
|
-- **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0**
|
|
|
-
|
|
|
-- **VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME** = **1**
|
|
|
-
|
|
|
-- **VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2**
|
|
|
-
|
|
|
-- **VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3**
|
|
|
-
|
|
|
-- **VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4**
|
|
|
-
|
|
|
-- **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5**
|
|
|
-
|
|
|
-- **VIEWPORT_RENDER_INFO_MAX** = **6** --- Marks end of VIEWPORT_RENDER_INFO\* constants. Used internally.
|
|
|
-
|
|
|
.. _enum_VisualServer_CubeMapSide:
|
|
|
|
|
|
enum **CubeMapSide**:
|
|
@@ -793,15 +775,39 @@ enum **TextureType**:
|
|
|
|
|
|
- **TEXTURE_TYPE_3D** = **3**
|
|
|
|
|
|
-.. _enum_VisualServer_LightType:
|
|
|
+.. _enum_VisualServer_TextureFlags:
|
|
|
|
|
|
-enum **LightType**:
|
|
|
+enum **TextureFlags**:
|
|
|
|
|
|
-- **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light.
|
|
|
+- **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
|
|
|
|
|
|
-- **LIGHT_OMNI** = **1** --- is an omni light.
|
|
|
+- **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge).
|
|
|
|
|
|
-- **LIGHT_SPOT** = **2** --- is an spot light.
|
|
|
+- **TEXTURE_FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture.
|
|
|
+
|
|
|
+- **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** --- Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
|
|
|
+
|
|
|
+More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases.
|
|
|
+
|
|
|
+- **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space.
|
|
|
+
|
|
|
+- **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeat texture with alternate sections mirrored.
|
|
|
+
|
|
|
+- **TEXTURE_FLAG_USED_FOR_STREAMING** = **2048** --- Texture is a video surface.
|
|
|
+
|
|
|
+- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.
|
|
|
+
|
|
|
+.. _enum_VisualServer_ShaderMode:
|
|
|
+
|
|
|
+enum **ShaderMode**:
|
|
|
+
|
|
|
+- **SHADER_SPATIAL** = **0** --- Shader is a 3D shader.
|
|
|
+
|
|
|
+- **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader.
|
|
|
+
|
|
|
+- **SHADER_PARTICLES** = **2** --- Shader is a particle shader.
|
|
|
+
|
|
|
+- **SHADER_MAX** = **3** --- Marks maximum of the shader types array. used internally.
|
|
|
|
|
|
.. _enum_VisualServer_ArrayType:
|
|
|
|
|
@@ -827,109 +833,89 @@ enum **ArrayType**:
|
|
|
|
|
|
- **ARRAY_MAX** = **9** --- Marks the maximum of the array types. Used internally.
|
|
|
|
|
|
-.. _enum_VisualServer_BlendShapeMode:
|
|
|
-
|
|
|
-enum **BlendShapeMode**:
|
|
|
-
|
|
|
-- **BLEND_SHAPE_MODE_NORMALIZED** = **0**
|
|
|
-
|
|
|
-- **BLEND_SHAPE_MODE_RELATIVE** = **1**
|
|
|
-
|
|
|
-.. _enum_VisualServer_ShadowCastingSetting:
|
|
|
-
|
|
|
-enum **ShadowCastingSetting**:
|
|
|
-
|
|
|
-- **SHADOW_CASTING_SETTING_OFF** = **0**
|
|
|
-
|
|
|
-- **SHADOW_CASTING_SETTING_ON** = **1**
|
|
|
-
|
|
|
-- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2**
|
|
|
-
|
|
|
-- **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3**
|
|
|
-
|
|
|
-.. _enum_VisualServer_CanvasOccluderPolygonCullMode:
|
|
|
+.. _enum_VisualServer_ArrayFormat:
|
|
|
|
|
|
-enum **CanvasOccluderPolygonCullMode**:
|
|
|
+enum **ArrayFormat**:
|
|
|
|
|
|
-- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled.
|
|
|
+- **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array.
|
|
|
|
|
|
-- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise.
|
|
|
+- **ARRAY_FORMAT_NORMAL** = **2** --- Flag used to mark a normal array.
|
|
|
|
|
|
-- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise.
|
|
|
+- **ARRAY_FORMAT_TANGENT** = **4** --- Flag used to mark a tangent array.
|
|
|
|
|
|
-.. _enum_VisualServer_ParticlesDrawOrder:
|
|
|
+- **ARRAY_FORMAT_COLOR** = **8** --- Flag used to mark a color array.
|
|
|
|
|
|
-enum **ParticlesDrawOrder**:
|
|
|
+- **ARRAY_FORMAT_TEX_UV** = **16** --- Flag used to mark a uv coordinates array.
|
|
|
|
|
|
-- **PARTICLES_DRAW_ORDER_INDEX** = **0**
|
|
|
+- **ARRAY_FORMAT_TEX_UV2** = **32** --- Flag used to mark a uv coordinates array for the second uv coordinates.
|
|
|
|
|
|
-- **PARTICLES_DRAW_ORDER_LIFETIME** = **1**
|
|
|
+- **ARRAY_FORMAT_BONES** = **64** --- Flag used to mark a bone information array.
|
|
|
|
|
|
-- **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2**
|
|
|
+- **ARRAY_FORMAT_WEIGHTS** = **128** --- Flag used to mark a weights array.
|
|
|
|
|
|
-.. _enum_VisualServer_ViewportMSAA:
|
|
|
+- **ARRAY_FORMAT_INDEX** = **256** --- Flag used to mark a index array.
|
|
|
|
|
|
-enum **ViewportMSAA**:
|
|
|
+- **ARRAY_COMPRESS_VERTEX** = **512** --- Flag used to mark a compressed (half float) vertex array.
|
|
|
|
|
|
-- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled.
|
|
|
+- **ARRAY_COMPRESS_NORMAL** = **1024** --- Flag used to mark a compressed (half float) normal array.
|
|
|
|
|
|
-- **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X.
|
|
|
+- **ARRAY_COMPRESS_TANGENT** = **2048** --- Flag used to mark a compressed (half float) tangent array.
|
|
|
|
|
|
-- **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4X.
|
|
|
+- **ARRAY_COMPRESS_COLOR** = **4096** --- Flag used to mark a compressed (half float) color array.
|
|
|
|
|
|
-- **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X.
|
|
|
+- **ARRAY_COMPRESS_TEX_UV** = **8192** --- Flag used to mark a compressed (half float) uv coordinates array.
|
|
|
|
|
|
-- **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X.
|
|
|
+- **ARRAY_COMPRESS_TEX_UV2** = **16384** --- Flag used to mark a compressed (half float) uv coordinates array for the second uv coordinates.
|
|
|
|
|
|
-.. _enum_VisualServer_ViewportUpdateMode:
|
|
|
+- **ARRAY_COMPRESS_BONES** = **32768**
|
|
|
|
|
|
-enum **ViewportUpdateMode**:
|
|
|
+- **ARRAY_COMPRESS_WEIGHTS** = **65536** --- Flag used to mark a compressed (half float) weight array.
|
|
|
|
|
|
-- **VIEWPORT_UPDATE_DISABLED** = **0**
|
|
|
+- **ARRAY_COMPRESS_INDEX** = **131072**
|
|
|
|
|
|
-- **VIEWPORT_UPDATE_ONCE** = **1**
|
|
|
+- **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices.
|
|
|
|
|
|
-- **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2**
|
|
|
+- **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16 bit bones instead of 8 bit.
|
|
|
|
|
|
-- **VIEWPORT_UPDATE_ALWAYS** = **3**
|
|
|
+- **ARRAY_COMPRESS_DEFAULT** = **97280** --- Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly.
|
|
|
|
|
|
-.. _enum_VisualServer_MultimeshColorFormat:
|
|
|
+.. _enum_VisualServer_PrimitiveType:
|
|
|
|
|
|
-enum **MultimeshColorFormat**:
|
|
|
+enum **PrimitiveType**:
|
|
|
|
|
|
-- **MULTIMESH_COLOR_NONE** = **0**
|
|
|
+- **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points.
|
|
|
|
|
|
-- **MULTIMESH_COLOR_8BIT** = **1**
|
|
|
+- **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines.
|
|
|
|
|
|
-- **MULTIMESH_COLOR_FLOAT** = **2**
|
|
|
+- **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end.
|
|
|
|
|
|
-.. _enum_VisualServer_LightDirectionalShadowMode:
|
|
|
+- **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex).
|
|
|
|
|
|
-enum **LightDirectionalShadowMode**:
|
|
|
+- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles.
|
|
|
|
|
|
-- **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = **0**
|
|
|
+- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
|
|
|
|
|
|
-- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = **1**
|
|
|
+- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle).
|
|
|
|
|
|
-- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = **2**
|
|
|
+- **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally.
|
|
|
|
|
|
-.. _enum_VisualServer_LightOmniShadowMode:
|
|
|
+.. _enum_VisualServer_BlendShapeMode:
|
|
|
|
|
|
-enum **LightOmniShadowMode**:
|
|
|
+enum **BlendShapeMode**:
|
|
|
|
|
|
-- **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0**
|
|
|
+- **BLEND_SHAPE_MODE_NORMALIZED** = **0**
|
|
|
|
|
|
-- **LIGHT_OMNI_SHADOW_CUBE** = **1**
|
|
|
+- **BLEND_SHAPE_MODE_RELATIVE** = **1**
|
|
|
|
|
|
-.. _enum_VisualServer_EnvironmentSSAOQuality:
|
|
|
+.. _enum_VisualServer_LightType:
|
|
|
|
|
|
-enum **EnvironmentSSAOQuality**:
|
|
|
+enum **LightType**:
|
|
|
|
|
|
-- **ENV_SSAO_QUALITY_LOW** = **0**
|
|
|
+- **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light.
|
|
|
|
|
|
-- **ENV_SSAO_QUALITY_MEDIUM** = **1**
|
|
|
+- **LIGHT_OMNI** = **1** --- is an omni light.
|
|
|
|
|
|
-- **ENV_SSAO_QUALITY_HIGH** = **2**
|
|
|
+- **LIGHT_SPOT** = **2** --- is an spot light.
|
|
|
|
|
|
.. _enum_VisualServer_LightParam:
|
|
|
|
|
@@ -965,75 +951,75 @@ enum **LightParam**:
|
|
|
|
|
|
- **LIGHT_PARAM_MAX** = **15** --- The light parameters endpoint. Used internally.
|
|
|
|
|
|
-.. _enum_VisualServer_ScenarioDebugMode:
|
|
|
+.. _enum_VisualServer_LightOmniShadowMode:
|
|
|
|
|
|
-enum **ScenarioDebugMode**:
|
|
|
+enum **LightOmniShadowMode**:
|
|
|
|
|
|
-- **SCENARIO_DEBUG_DISABLED** = **0**
|
|
|
+- **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = **0**
|
|
|
|
|
|
-- **SCENARIO_DEBUG_WIREFRAME** = **1**
|
|
|
+- **LIGHT_OMNI_SHADOW_CUBE** = **1**
|
|
|
|
|
|
-- **SCENARIO_DEBUG_OVERDRAW** = **2**
|
|
|
+.. _enum_VisualServer_LightOmniShadowDetail:
|
|
|
|
|
|
-- **SCENARIO_DEBUG_SHADELESS** = **3**
|
|
|
+enum **LightOmniShadowDetail**:
|
|
|
|
|
|
-.. _enum_VisualServer_LightDirectionalShadowDepthRangeMode:
|
|
|
+- **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0**
|
|
|
|
|
|
-enum **LightDirectionalShadowDepthRangeMode**:
|
|
|
+- **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1**
|
|
|
|
|
|
-- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE** = **0**
|
|
|
+.. _enum_VisualServer_LightDirectionalShadowMode:
|
|
|
|
|
|
-- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED** = **1**
|
|
|
+enum **LightDirectionalShadowMode**:
|
|
|
|
|
|
-.. _enum_VisualServer_EnvironmentGlowBlendMode:
|
|
|
+- **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = **0**
|
|
|
|
|
|
-enum **EnvironmentGlowBlendMode**:
|
|
|
+- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = **1**
|
|
|
|
|
|
-- **GLOW_BLEND_MODE_ADDITIVE** = **0**
|
|
|
+- **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = **2**
|
|
|
|
|
|
-- **GLOW_BLEND_MODE_SCREEN** = **1**
|
|
|
+.. _enum_VisualServer_LightDirectionalShadowDepthRangeMode:
|
|
|
|
|
|
-- **GLOW_BLEND_MODE_SOFTLIGHT** = **2**
|
|
|
+enum **LightDirectionalShadowDepthRangeMode**:
|
|
|
|
|
|
-- **GLOW_BLEND_MODE_REPLACE** = **3**
|
|
|
+- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_STABLE** = **0**
|
|
|
|
|
|
-.. _enum_VisualServer_InstanceType:
|
|
|
+- **LIGHT_DIRECTIONAL_SHADOW_DEPTH_RANGE_OPTIMIZED** = **1**
|
|
|
|
|
|
-enum **InstanceType**:
|
|
|
+.. _enum_VisualServer_ViewportUpdateMode:
|
|
|
|
|
|
-- **INSTANCE_NONE** = **0** --- The instance does not have a type.
|
|
|
+enum **ViewportUpdateMode**:
|
|
|
|
|
|
-- **INSTANCE_MESH** = **1** --- The instance is a mesh.
|
|
|
+- **VIEWPORT_UPDATE_DISABLED** = **0**
|
|
|
|
|
|
-- **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh.
|
|
|
+- **VIEWPORT_UPDATE_ONCE** = **1**
|
|
|
|
|
|
-- **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry.
|
|
|
+- **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2**
|
|
|
|
|
|
-- **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter.
|
|
|
+- **VIEWPORT_UPDATE_ALWAYS** = **3**
|
|
|
|
|
|
-- **INSTANCE_LIGHT** = **5** --- The instance is a light.
|
|
|
+.. _enum_VisualServer_ViewportClearMode:
|
|
|
|
|
|
-- **INSTANCE_REFLECTION_PROBE** = **6**
|
|
|
+enum **ViewportClearMode**:
|
|
|
|
|
|
-- **INSTANCE_GI_PROBE** = **7**
|
|
|
+- **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing.
|
|
|
|
|
|
-- **INSTANCE_LIGHTMAP_CAPTURE** = **8**
|
|
|
+- **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing.
|
|
|
|
|
|
-- **INSTANCE_MAX** = **9** --- The max value for INSTANCE\_\* constants, used internally.
|
|
|
+- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER.
|
|
|
|
|
|
-- **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
|
|
|
+.. _enum_VisualServer_ViewportMSAA:
|
|
|
|
|
|
-.. _enum_VisualServer_ShaderMode:
|
|
|
+enum **ViewportMSAA**:
|
|
|
|
|
|
-enum **ShaderMode**:
|
|
|
+- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled.
|
|
|
|
|
|
-- **SHADER_SPATIAL** = **0** --- Shader is a 3D shader.
|
|
|
+- **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X.
|
|
|
|
|
|
-- **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader.
|
|
|
+- **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4X.
|
|
|
|
|
|
-- **SHADER_PARTICLES** = **2** --- Shader is a particle shader.
|
|
|
+- **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X.
|
|
|
|
|
|
-- **SHADER_MAX** = **3** --- Marks maximum of the shader types array. used internally.
|
|
|
+- **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X.
|
|
|
|
|
|
.. _enum_VisualServer_ViewportUsage:
|
|
|
|
|
@@ -1047,163 +1033,143 @@ enum **ViewportUsage**:
|
|
|
|
|
|
- **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects.
|
|
|
|
|
|
-.. _enum_VisualServer_EnvironmentDOFBlurQuality:
|
|
|
-
|
|
|
-enum **EnvironmentDOFBlurQuality**:
|
|
|
-
|
|
|
-- **ENV_DOF_BLUR_QUALITY_LOW** = **0**
|
|
|
-
|
|
|
-- **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1**
|
|
|
-
|
|
|
-- **ENV_DOF_BLUR_QUALITY_HIGH** = **2**
|
|
|
-
|
|
|
-.. _enum_VisualServer_PrimitiveType:
|
|
|
-
|
|
|
-enum **PrimitiveType**:
|
|
|
-
|
|
|
-- **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points.
|
|
|
-
|
|
|
-- **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines.
|
|
|
-
|
|
|
-- **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end.
|
|
|
-
|
|
|
-- **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex).
|
|
|
+.. _enum_VisualServer_ViewportRenderInfo:
|
|
|
|
|
|
-- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles.
|
|
|
+enum **ViewportRenderInfo**:
|
|
|
|
|
|
-- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
|
|
|
+- **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0**
|
|
|
|
|
|
-- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle).
|
|
|
+- **VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME** = **1**
|
|
|
|
|
|
-- **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally.
|
|
|
+- **VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2**
|
|
|
|
|
|
-.. _enum_VisualServer_InstanceFlags:
|
|
|
+- **VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3**
|
|
|
|
|
|
-enum **InstanceFlags**:
|
|
|
+- **VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4**
|
|
|
|
|
|
-- **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0**
|
|
|
+- **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5**
|
|
|
|
|
|
-- **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1**
|
|
|
+- **VIEWPORT_RENDER_INFO_MAX** = **6** --- Marks end of VIEWPORT_RENDER_INFO\* constants. Used internally.
|
|
|
|
|
|
-- **INSTANCE_FLAG_MAX** = **2**
|
|
|
+.. _enum_VisualServer_ViewportDebugDraw:
|
|
|
|
|
|
-.. _enum_VisualServer_ViewportClearMode:
|
|
|
+enum **ViewportDebugDraw**:
|
|
|
|
|
|
-enum **ViewportClearMode**:
|
|
|
+- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting.
|
|
|
|
|
|
-- **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing.
|
|
|
+- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded.
|
|
|
|
|
|
-- **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing.
|
|
|
+- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``.
|
|
|
|
|
|
-- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER.
|
|
|
+- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe.
|
|
|
|
|
|
-.. _enum_VisualServer_LightOmniShadowDetail:
|
|
|
+.. _enum_VisualServer_ScenarioDebugMode:
|
|
|
|
|
|
-enum **LightOmniShadowDetail**:
|
|
|
+enum **ScenarioDebugMode**:
|
|
|
|
|
|
-- **LIGHT_OMNI_SHADOW_DETAIL_VERTICAL** = **0**
|
|
|
+- **SCENARIO_DEBUG_DISABLED** = **0**
|
|
|
|
|
|
-- **LIGHT_OMNI_SHADOW_DETAIL_HORIZONTAL** = **1**
|
|
|
+- **SCENARIO_DEBUG_WIREFRAME** = **1**
|
|
|
|
|
|
-.. _enum_VisualServer_CanvasLightMode:
|
|
|
+- **SCENARIO_DEBUG_OVERDRAW** = **2**
|
|
|
|
|
|
-enum **CanvasLightMode**:
|
|
|
+- **SCENARIO_DEBUG_SHADELESS** = **3**
|
|
|
|
|
|
-- **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas.
|
|
|
+.. _enum_VisualServer_InstanceType:
|
|
|
|
|
|
-- **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas.
|
|
|
+enum **InstanceType**:
|
|
|
|
|
|
-- **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency.
|
|
|
+- **INSTANCE_NONE** = **0** --- The instance does not have a type.
|
|
|
|
|
|
-- **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask.
|
|
|
+- **INSTANCE_MESH** = **1** --- The instance is a mesh.
|
|
|
|
|
|
-.. _enum_VisualServer_NinePatchAxisMode:
|
|
|
+- **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh.
|
|
|
|
|
|
-enum **NinePatchAxisMode**:
|
|
|
+- **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry.
|
|
|
|
|
|
-- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed.
|
|
|
+- **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter.
|
|
|
|
|
|
-- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed.
|
|
|
+- **INSTANCE_LIGHT** = **5** --- The instance is a light.
|
|
|
|
|
|
-- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed.
|
|
|
+- **INSTANCE_REFLECTION_PROBE** = **6**
|
|
|
|
|
|
-.. _enum_VisualServer_ViewportDebugDraw:
|
|
|
+- **INSTANCE_GI_PROBE** = **7**
|
|
|
|
|
|
-enum **ViewportDebugDraw**:
|
|
|
+- **INSTANCE_LIGHTMAP_CAPTURE** = **8**
|
|
|
|
|
|
-- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting.
|
|
|
+- **INSTANCE_MAX** = **9** --- The max value for INSTANCE\_\* constants, used internally.
|
|
|
|
|
|
-- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded.
|
|
|
+- **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
|
|
|
|
|
|
-- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``.
|
|
|
+.. _enum_VisualServer_InstanceFlags:
|
|
|
|
|
|
-- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe.
|
|
|
+enum **InstanceFlags**:
|
|
|
|
|
|
-.. _enum_VisualServer_MultimeshTransformFormat:
|
|
|
+- **INSTANCE_FLAG_USE_BAKED_LIGHT** = **0**
|
|
|
|
|
|
-enum **MultimeshTransformFormat**:
|
|
|
+- **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = **1**
|
|
|
|
|
|
-- **MULTIMESH_TRANSFORM_2D** = **0**
|
|
|
+- **INSTANCE_FLAG_MAX** = **2**
|
|
|
|
|
|
-- **MULTIMESH_TRANSFORM_3D** = **1**
|
|
|
+.. _enum_VisualServer_ShadowCastingSetting:
|
|
|
|
|
|
-.. _enum_VisualServer_ArrayFormat:
|
|
|
+enum **ShadowCastingSetting**:
|
|
|
|
|
|
-enum **ArrayFormat**:
|
|
|
+- **SHADOW_CASTING_SETTING_OFF** = **0**
|
|
|
|
|
|
-- **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array.
|
|
|
+- **SHADOW_CASTING_SETTING_ON** = **1**
|
|
|
|
|
|
-- **ARRAY_FORMAT_NORMAL** = **2** --- Flag used to mark a normal array.
|
|
|
+- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2**
|
|
|
|
|
|
-- **ARRAY_FORMAT_TANGENT** = **4** --- Flag used to mark a tangent array.
|
|
|
+- **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3**
|
|
|
|
|
|
-- **ARRAY_FORMAT_COLOR** = **8** --- Flag used to mark a color array.
|
|
|
+.. _enum_VisualServer_NinePatchAxisMode:
|
|
|
|
|
|
-- **ARRAY_FORMAT_TEX_UV** = **16** --- Flag used to mark a uv coordinates array.
|
|
|
+enum **NinePatchAxisMode**:
|
|
|
|
|
|
-- **ARRAY_FORMAT_TEX_UV2** = **32** --- Flag used to mark a uv coordinates array for the second uv coordinates.
|
|
|
+- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed.
|
|
|
|
|
|
-- **ARRAY_FORMAT_BONES** = **64** --- Flag used to mark a bone information array.
|
|
|
+- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed.
|
|
|
|
|
|
-- **ARRAY_FORMAT_WEIGHTS** = **128** --- Flag used to mark a weights array.
|
|
|
+- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed.
|
|
|
|
|
|
-- **ARRAY_FORMAT_INDEX** = **256** --- Flag used to mark a index array.
|
|
|
+.. _enum_VisualServer_CanvasLightMode:
|
|
|
|
|
|
-- **ARRAY_COMPRESS_VERTEX** = **512** --- Flag used to mark a compressed (half float) vertex array.
|
|
|
+enum **CanvasLightMode**:
|
|
|
|
|
|
-- **ARRAY_COMPRESS_NORMAL** = **1024** --- Flag used to mark a compressed (half float) normal array.
|
|
|
+- **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas.
|
|
|
|
|
|
-- **ARRAY_COMPRESS_TANGENT** = **2048** --- Flag used to mark a compressed (half float) tangent array.
|
|
|
+- **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas.
|
|
|
|
|
|
-- **ARRAY_COMPRESS_COLOR** = **4096** --- Flag used to mark a compressed (half float) color array.
|
|
|
+- **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency.
|
|
|
|
|
|
-- **ARRAY_COMPRESS_TEX_UV** = **8192** --- Flag used to mark a compressed (half float) uv coordinates array.
|
|
|
+- **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask.
|
|
|
|
|
|
-- **ARRAY_COMPRESS_TEX_UV2** = **16384** --- Flag used to mark a compressed (half float) uv coordinates array for the second uv coordinates.
|
|
|
+.. _enum_VisualServer_CanvasLightShadowFilter:
|
|
|
|
|
|
-- **ARRAY_COMPRESS_BONES** = **32768**
|
|
|
+enum **CanvasLightShadowFilter**:
|
|
|
|
|
|
-- **ARRAY_COMPRESS_WEIGHTS** = **65536** --- Flag used to mark a compressed (half float) weight array.
|
|
|
+- **CANVAS_LIGHT_FILTER_NONE** = **0**
|
|
|
|
|
|
-- **ARRAY_COMPRESS_INDEX** = **131072**
|
|
|
+- **CANVAS_LIGHT_FILTER_PCF3** = **1**
|
|
|
|
|
|
-- **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices.
|
|
|
+- **CANVAS_LIGHT_FILTER_PCF5** = **2**
|
|
|
|
|
|
-- **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16 bit bones instead of 8 bit.
|
|
|
+- **CANVAS_LIGHT_FILTER_PCF7** = **3**
|
|
|
|
|
|
-- **ARRAY_COMPRESS_DEFAULT** = **97280** --- Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly.
|
|
|
+- **CANVAS_LIGHT_FILTER_PCF9** = **4**
|
|
|
|
|
|
-.. _enum_VisualServer_EnvironmentSSAOBlur:
|
|
|
+- **CANVAS_LIGHT_FILTER_PCF13** = **5**
|
|
|
|
|
|
-enum **EnvironmentSSAOBlur**:
|
|
|
+.. _enum_VisualServer_CanvasOccluderPolygonCullMode:
|
|
|
|
|
|
-- **ENV_SSAO_BLUR_DISABLED** = **0**
|
|
|
+enum **CanvasOccluderPolygonCullMode**:
|
|
|
|
|
|
-- **ENV_SSAO_BLUR_1x1** = **1**
|
|
|
+- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled.
|
|
|
|
|
|
-- **ENV_SSAO_BLUR_2x2** = **2**
|
|
|
+- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise.
|
|
|
|
|
|
-- **ENV_SSAO_BLUR_3x3** = **3**
|
|
|
+- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise.
|
|
|
|
|
|
.. _enum_VisualServer_RenderInfo:
|
|
|
|
|
@@ -1229,6 +1195,32 @@ enum **RenderInfo**:
|
|
|
|
|
|
- **INFO_VERTEX_MEM_USED** = **9** --- The amount of vertex memory used.
|
|
|
|
|
|
+.. _enum_VisualServer_Features:
|
|
|
+
|
|
|
+enum **Features**:
|
|
|
+
|
|
|
+- **FEATURE_SHADERS** = **0**
|
|
|
+
|
|
|
+- **FEATURE_MULTITHREADED** = **1**
|
|
|
+
|
|
|
+.. _enum_VisualServer_MultimeshTransformFormat:
|
|
|
+
|
|
|
+enum **MultimeshTransformFormat**:
|
|
|
+
|
|
|
+- **MULTIMESH_TRANSFORM_2D** = **0**
|
|
|
+
|
|
|
+- **MULTIMESH_TRANSFORM_3D** = **1**
|
|
|
+
|
|
|
+.. _enum_VisualServer_MultimeshColorFormat:
|
|
|
+
|
|
|
+enum **MultimeshColorFormat**:
|
|
|
+
|
|
|
+- **MULTIMESH_COLOR_NONE** = **0**
|
|
|
+
|
|
|
+- **MULTIMESH_COLOR_8BIT** = **1**
|
|
|
+
|
|
|
+- **MULTIMESH_COLOR_FLOAT** = **2**
|
|
|
+
|
|
|
.. _enum_VisualServer_ReflectionProbeUpdateMode:
|
|
|
|
|
|
enum **ReflectionProbeUpdateMode**:
|
|
@@ -1237,6 +1229,16 @@ enum **ReflectionProbeUpdateMode**:
|
|
|
|
|
|
- **REFLECTION_PROBE_UPDATE_ALWAYS** = **1**
|
|
|
|
|
|
+.. _enum_VisualServer_ParticlesDrawOrder:
|
|
|
+
|
|
|
+enum **ParticlesDrawOrder**:
|
|
|
+
|
|
|
+- **PARTICLES_DRAW_ORDER_INDEX** = **0**
|
|
|
+
|
|
|
+- **PARTICLES_DRAW_ORDER_LIFETIME** = **1**
|
|
|
+
|
|
|
+- **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = **2**
|
|
|
+
|
|
|
.. _enum_VisualServer_EnvironmentBG:
|
|
|
|
|
|
enum **EnvironmentBG**:
|
|
@@ -1255,63 +1257,61 @@ enum **EnvironmentBG**:
|
|
|
|
|
|
- **ENV_BG_MAX** = **6**
|
|
|
|
|
|
-.. _enum_VisualServer_CanvasLightShadowFilter:
|
|
|
-
|
|
|
-enum **CanvasLightShadowFilter**:
|
|
|
+.. _enum_VisualServer_EnvironmentDOFBlurQuality:
|
|
|
|
|
|
-- **CANVAS_LIGHT_FILTER_NONE** = **0**
|
|
|
+enum **EnvironmentDOFBlurQuality**:
|
|
|
|
|
|
-- **CANVAS_LIGHT_FILTER_PCF3** = **1**
|
|
|
+- **ENV_DOF_BLUR_QUALITY_LOW** = **0**
|
|
|
|
|
|
-- **CANVAS_LIGHT_FILTER_PCF5** = **2**
|
|
|
+- **ENV_DOF_BLUR_QUALITY_MEDIUM** = **1**
|
|
|
|
|
|
-- **CANVAS_LIGHT_FILTER_PCF7** = **3**
|
|
|
+- **ENV_DOF_BLUR_QUALITY_HIGH** = **2**
|
|
|
|
|
|
-- **CANVAS_LIGHT_FILTER_PCF9** = **4**
|
|
|
+.. _enum_VisualServer_EnvironmentGlowBlendMode:
|
|
|
|
|
|
-- **CANVAS_LIGHT_FILTER_PCF13** = **5**
|
|
|
+enum **EnvironmentGlowBlendMode**:
|
|
|
|
|
|
-.. _enum_VisualServer_Features:
|
|
|
+- **GLOW_BLEND_MODE_ADDITIVE** = **0**
|
|
|
|
|
|
-enum **Features**:
|
|
|
+- **GLOW_BLEND_MODE_SCREEN** = **1**
|
|
|
|
|
|
-- **FEATURE_SHADERS** = **0**
|
|
|
+- **GLOW_BLEND_MODE_SOFTLIGHT** = **2**
|
|
|
|
|
|
-- **FEATURE_MULTITHREADED** = **1**
|
|
|
+- **GLOW_BLEND_MODE_REPLACE** = **3**
|
|
|
|
|
|
-.. _enum_VisualServer_TextureFlags:
|
|
|
+.. _enum_VisualServer_EnvironmentToneMapper:
|
|
|
|
|
|
-enum **TextureFlags**:
|
|
|
+enum **EnvironmentToneMapper**:
|
|
|
|
|
|
-- **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
|
|
|
+- **ENV_TONE_MAPPER_LINEAR** = **0**
|
|
|
|
|
|
-- **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge).
|
|
|
+- **ENV_TONE_MAPPER_REINHARD** = **1**
|
|
|
|
|
|
-- **TEXTURE_FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture.
|
|
|
+- **ENV_TONE_MAPPER_FILMIC** = **2**
|
|
|
|
|
|
-- **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** --- Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
|
|
|
+- **ENV_TONE_MAPPER_ACES** = **3**
|
|
|
|
|
|
-More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases.
|
|
|
+.. _enum_VisualServer_EnvironmentSSAOQuality:
|
|
|
|
|
|
-- **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space.
|
|
|
+enum **EnvironmentSSAOQuality**:
|
|
|
|
|
|
-- **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeat texture with alternate sections mirrored.
|
|
|
+- **ENV_SSAO_QUALITY_LOW** = **0**
|
|
|
|
|
|
-- **TEXTURE_FLAG_USED_FOR_STREAMING** = **2048** --- Texture is a video surface.
|
|
|
+- **ENV_SSAO_QUALITY_MEDIUM** = **1**
|
|
|
|
|
|
-- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.
|
|
|
+- **ENV_SSAO_QUALITY_HIGH** = **2**
|
|
|
|
|
|
-.. _enum_VisualServer_EnvironmentToneMapper:
|
|
|
+.. _enum_VisualServer_EnvironmentSSAOBlur:
|
|
|
|
|
|
-enum **EnvironmentToneMapper**:
|
|
|
+enum **EnvironmentSSAOBlur**:
|
|
|
|
|
|
-- **ENV_TONE_MAPPER_LINEAR** = **0**
|
|
|
+- **ENV_SSAO_BLUR_DISABLED** = **0**
|
|
|
|
|
|
-- **ENV_TONE_MAPPER_REINHARD** = **1**
|
|
|
+- **ENV_SSAO_BLUR_1x1** = **1**
|
|
|
|
|
|
-- **ENV_TONE_MAPPER_FILMIC** = **2**
|
|
|
+- **ENV_SSAO_BLUR_2x2** = **2**
|
|
|
|
|
|
-- **ENV_TONE_MAPPER_ACES** = **3**
|
|
|
+- **ENV_SSAO_BLUR_3x3** = **3**
|
|
|
|
|
|
Constants
|
|
|
---------
|