godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source, adds Enums

Browse Source
This commit is contained in:
Rémi Verschelde
2018-01-12 08:52:43 +01:00
parent d2eaa67ef0
commit 4548bb71d5
142 changed files with 2620 additions and 1147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

297
classes/class_visualserver.rst
View File

@@ -390,27 +390,163 @@ Numeric Constants
- **MAX_CURSORS** = **8**
- **MATERIAL_RENDER_PRIORITY_MIN** = **-128** --- The minimum renderpriority of all materials.
- **MATERIAL_RENDER_PRIORITY_MAX** = **127** --- The maximum renderpriority of all materials.
Enums
-----
.. _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**
- **CUBEMAP_LEFT** = **0** --- Marks the left side of a cubemap.
- **CUBEMAP_RIGHT** = **1** --- Marks the right side of a cubemap.
- **CUBEMAP_BOTTOM** = **2** --- Marks the bottom side of a cubemap.
- **CUBEMAP_TOP** = **3** --- Marks the top side of a cubemap.
- **CUBEMAP_FRONT** = **4** --- Marks the front side of a cubemap.
- **CUBEMAP_BACK** = **5** --- Marks the back side of a cubemap.
- **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
- **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge).
- **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_CUBEMAP** = **2048** --- Texture is a cubemap.
- **TEXTURE_FLAG_USED_FOR_STREAMING** = **4096** --- Texture is a video surface.
- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.
.. _enum_VisualServer_LightType:
enum **LightType**
- **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light.
- **LIGHT_OMNI** = **1** --- is an omni light.
- **LIGHT_SPOT** = **2** --- is an spot light.
.. _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).
- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles.
- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 verticies are always combined to make a triangle).
- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 verticies are always combined with the first to make a triangle).
- **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally.
.. _enum_VisualServer_BlendShapeMode:
enum **BlendShapeMode**
- **BLEND_SHAPE_MODE_NORMALIZED** = **0**
- **BLEND_SHAPE_MODE_RELATIVE** = **1**
.. _enum_VisualServer_CanvasOccluderPolygonCullMode:
enum **CanvasOccluderPolygonCullMode**
- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled.
- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise.
- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise.
.. _enum_VisualServer_ViewportMSAA:
enum **ViewportMSAA**
- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled.
- **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X.
- **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4X.
- **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X.
- **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X.
.. _enum_VisualServer_ViewportUpdateMode:
enum **ViewportUpdateMode**
- **VIEWPORT_UPDATE_DISABLED** = **0**
- **VIEWPORT_UPDATE_ONCE** = **1**
- **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2**
- **VIEWPORT_UPDATE_ALWAYS** = **3**
.. _enum_VisualServer_LightParam:
enum **LightParam**
- **LIGHT_PARAM_ENERGY** = **0** --- The light's energy.
- **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity.
- **LIGHT_PARAM_RANGE** = **3** --- The light's range.
- **LIGHT_PARAM_ATTENUATION** = **4** --- The light's attenuation.
- **LIGHT_PARAM_SPOT_ANGLE** = **5** --- The spotlight's angle.
- **LIGHT_PARAM_SPOT_ATTENUATION** = **6** --- The spotlight's attenuation.
- **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **7** --- Scales the shadow color.
- **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **8**
- **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **9**
- **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **10**
- **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **11**
- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **12**
- **LIGHT_PARAM_SHADOW_BIAS** = **13**
- **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14**
- **LIGHT_PARAM_MAX** = **15** --- The light parameters endpoint. Used internally.
.. _enum_VisualServer_ScenarioDebugMode:
enum **ScenarioDebugMode**
- **SCENARIO_DEBUG_DISABLED** = **0**
- **SCENARIO_DEBUG_WIREFRAME** = **1**
- **SCENARIO_DEBUG_OVERDRAW** = **2**
- **SCENARIO_DEBUG_SHADELESS** = **3**
.. _enum_VisualServer_InstanceType:
enum **InstanceType**
- **INSTANCE_NONE** = **0** --- The instance does not have a type.
- **INSTANCE_MESH** = **1** --- The instance is a mesh.
- **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh.
- **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry.
- **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter.
- **INSTANCE_LIGHT** = **5** --- The instance is a light.
- **INSTANCE_REFLECTION_PROBE** = **6**
- **INSTANCE_GI_PROBE** = **7**
- **INSTANCE_LIGHTMAP_CAPTURE** = **8**
- **INSTANCE_MAX** = **9** --- The max value for INSTANCE\_\* constants, used internally.
- **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
.. _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_ViewportUsage:
enum **ViewportUsage**
- **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples.
- **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample.
- **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects.
- **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects.
.. _enum_VisualServer_ViewportClearMode:
enum **ViewportClearMode**
- **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing.
- **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing.
- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER.
.. _enum_VisualServer_ArrayType:
enum **ArrayType**
- **ARRAY_VERTEX** = **0** --- Array is a vertex array.
- **ARRAY_NORMAL** = **1** --- Array is a normal array.
- **ARRAY_TANGENT** = **2** --- Array is a tangent array.
@@ -421,6 +557,20 @@ More effective on planes often shown going to the horrizon as those textures (Wa
- **ARRAY_WEIGHTS** = **7** --- Array is weight information.
- **ARRAY_INDEX** = **8** --- Array is index array.
- **ARRAY_MAX** = **9** --- Marks the maximum of the array types. Used internally.
.. _enum_VisualServer_CanvasLightMode:
enum **CanvasLightMode**
- **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas.
- **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas.
- **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency.
- **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask.
.. _enum_VisualServer_ArrayFormat:
enum **ArrayFormat**
- **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array.
- **ARRAY_FORMAT_NORMAL** = **2** --- Flag used to mark a normal array.
- **ARRAY_FORMAT_TANGENT** = **4** --- Flag used to mark a tangent array.
@@ -442,92 +592,28 @@ More effective on planes often shown going to the horrizon as those textures (Wa
- **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices.
- **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16 bit bones instead of 8 bit.
- **ARRAY_COMPRESS_DEFAULT** = **97792** --- 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.
- **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).
- **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles.
- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 verticies are always combined to make a triangle).
- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 verticies are always combined with the first to make a triangle).
- **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally.
- **BLEND_SHAPE_MODE_NORMALIZED** = **0**
- **BLEND_SHAPE_MODE_RELATIVE** = **1**
- **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light.
- **LIGHT_OMNI** = **1** --- is an omni light.
- **LIGHT_SPOT** = **2** --- is an spot light.
- **LIGHT_PARAM_ENERGY** = **0** --- The light's energy.
- **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity.
- **LIGHT_PARAM_RANGE** = **3** --- The light's range.
- **LIGHT_PARAM_ATTENUATION** = **4** --- The light's attenuation.
- **LIGHT_PARAM_SPOT_ANGLE** = **5** --- The spotlight's angle.
- **LIGHT_PARAM_SPOT_ATTENUATION** = **6** --- The spotlight's attenuation.
- **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **7** --- Scales the shadow color.
- **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **8**
- **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **9**
- **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **10**
- **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **11**
- **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **12**
- **LIGHT_PARAM_SHADOW_BIAS** = **13**
- **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14**
- **LIGHT_PARAM_MAX** = **15** --- The light parameters endpoint. Used internally.
- **VIEWPORT_UPDATE_DISABLED** = **0**
- **VIEWPORT_UPDATE_ONCE** = **1**
- **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2**
- **VIEWPORT_UPDATE_ALWAYS** = **3**
- **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing.
- **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing.
- **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER.
- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled.
- **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X.
- **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4X.
- **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X.
- **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X.
- **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples.
- **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample.
- **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects.
- **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects.
- **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_ViewportDebugDraw:
enum **ViewportDebugDraw**
- **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting.
- **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded.
- **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``.
- **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe.
- **SCENARIO_DEBUG_DISABLED** = **0**
- **SCENARIO_DEBUG_WIREFRAME** = **1**
- **SCENARIO_DEBUG_OVERDRAW** = **2**
- **SCENARIO_DEBUG_SHADELESS** = **3**
- **INSTANCE_NONE** = **0** --- The instance does not have a type.
- **INSTANCE_MESH** = **1** --- The instance is a mesh.
- **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh.
- **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry.
- **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter.
- **INSTANCE_LIGHT** = **5** --- The instance is a light.
- **INSTANCE_REFLECTION_PROBE** = **6**
- **INSTANCE_GI_PROBE** = **7**
- **INSTANCE_LIGHTMAP_CAPTURE** = **8**
- **INSTANCE_MAX** = **9** --- The max value for INSTANCE\_\* constants, used internally.
- **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
.. _enum_VisualServer_NinePatchAxisMode:
enum **NinePatchAxisMode**
- **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed.
- **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed.
- **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed.
- **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas.
- **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas.
- **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency.
- **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask.
- **CANVAS_LIGHT_FILTER_NONE** = **0**
- **CANVAS_LIGHT_FILTER_PCF3** = **1**
- **CANVAS_LIGHT_FILTER_PCF5** = **2**
- **CANVAS_LIGHT_FILTER_PCF7** = **3**
- **CANVAS_LIGHT_FILTER_PCF9** = **4**
- **CANVAS_LIGHT_FILTER_PCF13** = **5**
- **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled.
- **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise.
- **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise.
.. _enum_VisualServer_RenderInfo:
enum **RenderInfo**
- **INFO_OBJECTS_IN_FRAME** = **0** --- The amount of objects in the frame.
- **INFO_VERTICES_IN_FRAME** = **1** --- The amount of vertices in the frame.
- **INFO_MATERIAL_CHANGES_IN_FRAME** = **2** --- The amount of modified materials in the frame.
@@ -538,9 +624,42 @@ More effective on planes often shown going to the horrizon as those textures (Wa
- **INFO_VIDEO_MEM_USED** = **7** --- The amount of vertex memory and texture memory used.
- **INFO_TEXTURE_MEM_USED** = **8** --- The amount of texture memory used.
- **INFO_VERTEX_MEM_USED** = **9** --- The amount of vertex memory used.
.. _enum_VisualServer_CanvasLightShadowFilter:
enum **CanvasLightShadowFilter**
- **CANVAS_LIGHT_FILTER_NONE** = **0**
- **CANVAS_LIGHT_FILTER_PCF3** = **1**
- **CANVAS_LIGHT_FILTER_PCF5** = **2**
- **CANVAS_LIGHT_FILTER_PCF7** = **3**
- **CANVAS_LIGHT_FILTER_PCF9** = **4**
- **CANVAS_LIGHT_FILTER_PCF13** = **5**
.. _enum_VisualServer_Features:
enum **Features**
- **FEATURE_SHADERS** = **0**
- **FEATURE_MULTITHREADED** = **1**
.. _enum_VisualServer_TextureFlags:
enum **TextureFlags**
- **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
- **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge).
- **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_CUBEMAP** = **2048** --- Texture is a cubemap.
- **TEXTURE_FLAG_USED_FOR_STREAMING** = **4096** --- Texture is a video surface.
- **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.
Description
-----------