From 46b574215912723c38ba4a7287777d5bd5d91096 Mon Sep 17 00:00:00 2001 From: clayjohn Date: Tue, 14 Jan 2020 13:27:14 -0800 Subject: [PATCH] Completed documentation for many visual nodes --- doc/classes/ArrayMesh.xml | 2 ++ doc/classes/Geometry.xml | 2 ++ doc/classes/GeometryInstance.xml | 2 ++ doc/classes/Image.xml | 17 ++++++++++++++++- doc/classes/Light.xml | 18 ++++++++++++++++++ doc/classes/Mesh.xml | 25 +++++++++++++++++++++++++ doc/classes/MeshInstance.xml | 1 + doc/classes/MeshInstance2D.xml | 1 + doc/classes/MultiMeshInstance.xml | 1 + doc/classes/MultiMeshInstance2D.xml | 1 + doc/classes/OmniLight.xml | 2 ++ doc/classes/Texture3D.xml | 2 ++ doc/classes/VisualInstance.xml | 9 +++++++-- 13 files changed, 80 insertions(+), 3 deletions(-) diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 62ff0edbd24..e3e9c38419e 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -23,6 +23,7 @@ The [code]MeshInstance[/code] is ready to be added to the SceneTree to be shown. + http://docs.godotengine.org/en/latest/tutorials/content/procedural_geometry/arraymesh.html @@ -185,6 +186,7 @@ + Sets the blend shape mode to one of [enum Mesh.BlendShapeMode]. Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices. diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 3824baa4dc8..dbc06f7c4f8 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -1,8 +1,10 @@ + Helper node to calculate generic geometry operations. + Geometry provides users with a set of helper functions to create geometric shapes, compute intersections between shapes, and process various other geometric operations. diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index 02f2c27043d..980815e5fd6 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -15,6 +15,7 @@ + Returns the [enum GeometryInstance.Flags] that have been set for this object. @@ -34,6 +35,7 @@ + Sets the [enum GeometryInstance.Flags] specified. See [enum GeometryInstance.Flags] for options. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 03035851206..612b9ed3f5e 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -71,6 +71,7 @@ + Converts a bumpmap to a normalmap. A bumpmap provides a height offset per-pixel, while a normalmap provides a normal direction per pixel. @@ -165,7 +166,7 @@ - Returns [constant ALPHA_BLEND] if the image has data for alpha values. Returns [constant ALPHA_BIT] if all the alpha values are below a certain threshold or the maximum value. Returns [constant ALPHA_NONE] if no data for alpha values is found. + Returns [constant ALPHA_BLEND] if the image has data for alpha values. Returns [constant ALPHA_BIT] if all the alpha values are stored in a single bit. Returns [constant ALPHA_NONE] if no data for alpha values is found. @@ -405,6 +406,7 @@ + Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image. @@ -502,8 +504,10 @@ The maximal height allowed for [Image] resources. + Texture format with a single 8-bit depth representing luminance. + OpenGL texture format with two values, luminance and alpha each stored with 8 bits. OpenGL texture format [code]RED[/code] with a single component and a bitdepth of 8. @@ -643,26 +647,37 @@ Performs Lanczos interpolation. This is the slowest image resizing mode, but it typically gives the best results, especially when downscalng images. + Image does not have alpha. + Image stores alpha in a single bit. + Image uses alpha. + Use S3TC compression. + Use PVRTC2 compression. + Use PVRTC4 compression. + Use ETC compression. + Use ETC2 compression. + Source texture (before compression) is a regular texture. Default for all textures. + Source texture (before compression) is in sRGB space. + Source texture (before compression) is a normal texture (e.g. it can be compressed into two channels). diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index 6ef7c2652d3..fde25ef2c5f 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -16,6 +16,7 @@ + Returns the value of the specified [enum Light.Param] parameter. @@ -26,6 +27,7 @@ + Sets the value of the specified [enum Light.Param] parameter. @@ -67,38 +69,54 @@ If [code]true[/code], the light will cast shadows. + If [code]true[/code], reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with [constant GeometryInstance.SHADOW_CASTING_SETTING_DOUBLE_SIDED]. + Constant for accessing [member light_energy]. + Constant for accessing [member light_indirect_energy]. + Constant for accessing [member light_specular]. + Constant for accessing [member OmniLight.omni_range] or [member SpotLight.spot_range]. + Constant for accessing [member OmniLight.omni_attenuation] or [member SpotLight.spot_attenuation]. + Constant for accessing [member SpotLight.spot_angle]. + Constant for accessing [member SpotLight.spot_angle_attenuation]. + Constant for accessing [member shadow_contact]. + Constant for accessing [member DirectionalLight.directional_shadow_max_distance]. + Constant for accessing [member DirectionalLight.directional_shadow_split_1]. + Constant for accessing [member DirectionalLight.directional_shadow_split_2]. + Constant for accessing [member DirectionalLight.directional_shadow_split_3]. + Constant for accessing [member DirectionalLight.directional_shadow_normal_bias]. + Constant for accessing [member shadow_bias]. + Constant for accessing [member DirectionalLight.directional_shadow_bias_split_scale]. Represents the size of the [enum Param] enum. diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index d4804930e1f..2dd3ce55291 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -103,6 +103,7 @@ + Sets a hint to be used for lightmap resolution in [BakedLightmap]. Overrides [member BakedLightmap.bake_default_texels_per_unit]. @@ -128,52 +129,76 @@ Render array as triangle fans. + Blend shapes are normalized. + Blend shapes are relative to base weight. + Mesh array contains vertices. All meshes require a vertex array so this should always be present. + Mesh array contains normals. + Mesh array contains tangents. + Mesh array contains colors. + Mesh array contains UVs. + Mesh array contains second UV. + Mesh array contains bones. + Mesh array contains bone weights. + Mesh array uses indices. + Used internally to calculate other [code]ARRAY_COMPRESS_*[/code] enum values. Do not use. + Flag used to mark a compressed (half float) vertex array. + Flag used to mark a compressed (half float) normal array. + Flag used to mark a compressed (half float) tangent array. + Flag used to mark a compressed (half float) color array. + Flag used to mark a compressed (half float) UV coordinates array. + Flag used to mark a compressed (half float) UV coordinates array for the second UV coordinates. + Flag used to mark a compressed bone array. + Flag used to mark a compressed (half float) weight array. + Flag used to mark a compressed index array. + Flag used to mark that the array contains 2D vertices. + Flag used to mark that the array uses 16-bit bones instead of 8-bit. + Used to set flags [constant ARRAY_COMPRESS_VERTEX], [constant ARRAY_COMPRESS_NORMAL], [constant ARRAY_COMPRESS_TANGENT], [constant ARRAY_COMPRESS_COLOR], [constant ARRAY_COMPRESS_TEX_UV], [constant ARRAY_COMPRESS_TEX_UV2] and [constant ARRAY_COMPRESS_WEIGHTS] quickly. Array of vertices. diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index a4d2bb42959..c7cddf59773 100644 --- a/doc/classes/MeshInstance.xml +++ b/doc/classes/MeshInstance.xml @@ -66,6 +66,7 @@ [NodePath] to the [Skeleton] associated with the instance. + Sets the skin to be used by this instance. diff --git a/doc/classes/MeshInstance2D.xml b/doc/classes/MeshInstance2D.xml index 4b38b9aa96a..7f1466ccf6e 100644 --- a/doc/classes/MeshInstance2D.xml +++ b/doc/classes/MeshInstance2D.xml @@ -25,6 +25,7 @@ + Emitted when the [member texture] is changed. diff --git a/doc/classes/MultiMeshInstance.xml b/doc/classes/MultiMeshInstance.xml index 16f16fdc8b9..7dcfd2808d4 100644 --- a/doc/classes/MultiMeshInstance.xml +++ b/doc/classes/MultiMeshInstance.xml @@ -10,6 +10,7 @@ http://docs.godotengine.org/en/latest/tutorials/3d/vertex_animation/animating_thousands_of_fish.html http://docs.godotengine.org/en/latest/tutorials/3d/using_multi_mesh_instance.html + http://docs.godotengine.org/en/latest/tutorials/optimization/using_multimesh.html diff --git a/doc/classes/MultiMeshInstance2D.xml b/doc/classes/MultiMeshInstance2D.xml index 8509986c3c8..0c6f1a4a62b 100644 --- a/doc/classes/MultiMeshInstance2D.xml +++ b/doc/classes/MultiMeshInstance2D.xml @@ -25,6 +25,7 @@ + Emitted when the [member texture] is changed. diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml index 7189826385d..646c2d31664 100644 --- a/doc/classes/OmniLight.xml +++ b/doc/classes/OmniLight.xml @@ -33,8 +33,10 @@ Shadows are rendered to a cubemap. Slower than [constant SHADOW_DUAL_PARABOLOID], but higher-quality. + Use more detail vertically when computing the shadow. + Use more detail horizontally when computing the shadow. diff --git a/doc/classes/Texture3D.xml b/doc/classes/Texture3D.xml index c11a48137f6..aac55710fed 100644 --- a/doc/classes/Texture3D.xml +++ b/doc/classes/Texture3D.xml @@ -1,8 +1,10 @@ + Texture with 3 dimensions. + Texture3D is a 3-dimensional texture that has a width, height, and depth. diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index 7576bf7ad80..692e0516745 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -1,8 +1,10 @@ + Parent of all visual 3D nodes. + The VisualInstance is used to connect a resource to a visual representation. All visual 3D nodes inherit from the VisualInstance. In general, you should not access the VisualInstance properties directly as they are accessed and managed by the nodes that inherit from VisualInstance. VisualInstance is the node representation of the [VisualServer] instance. @@ -18,12 +20,14 @@ + Returns the RID of the resource associated with this VisualInstance. For example, if the Node is a [MeshInstance], this will return the RID of the associated [Mesh]. + Returns the RID of this instance. This RID is the same as the RID returned by [method VisualServer.instance_create]. This RID is needed if you want to call [VisualServer] functions directly on this VisualInstance. @@ -32,6 +36,7 @@ + Returns [code]true[/code] when the specified layer is enabled in [member layers] and [code]false[/code] otherwise. @@ -48,8 +53,7 @@ - Sets the base of the VisualInstance, which changes how the engine handles the VisualInstance under the hood. - It is recommended to only use [method set_base] if you know what you're doing. + Sets the resource that is instantiated by this VisualInstance, which changes how the engine handles the VisualInstance under the hood. Equivalent to [method VisualServer.instance_set_base]. @@ -60,6 +64,7 @@ + Enables a particular layer in [member layers].