From c5700f74648d8b04229f4d4c77937c1af3a798a7 Mon Sep 17 00:00:00 2001 From: clayjohn Date: Sat, 25 Jan 2020 21:59:51 -0800 Subject: [PATCH] Complete various class references --- doc/classes/CPUParticles.xml | 3 ++ doc/classes/CPUParticles2D.xml | 3 ++ doc/classes/CanvasLayer.xml | 2 ++ doc/classes/Geometry.xml | 1 + doc/classes/ParticlesMaterial.xml | 8 +++++ doc/classes/Plane.xml | 3 ++ doc/classes/ProceduralSky.xml | 5 +++ doc/classes/Quat.xml | 1 + doc/classes/Spatial.xml | 3 +- doc/classes/SurfaceTool.xml | 2 ++ doc/classes/Texture.xml | 8 ++++- doc/classes/TextureArray.xml | 2 ++ doc/classes/TextureLayered.xml | 2 ++ doc/classes/Viewport.xml | 31 +++++++++++++++---- doc/classes/VisualServer.xml | 2 +- .../opensimplex/doc_classes/NoiseTexture.xml | 1 + 16 files changed, 68 insertions(+), 9 deletions(-) diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index 97bd673f0ba..6f7fbaecce7 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -172,10 +172,13 @@ The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX]. + Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. + Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS]. + Sets the initial positions to spawn particles when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. Particles will be emitted inside this region. See [enum EmissionShape] for possible values. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 706083e86d1..4694fd46633 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -170,10 +170,13 @@ Particle draw order. Uses [enum DrawOrder] values. + Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. + Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS]. + Sets the initial positions to spawn particles when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE]. diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 2e56009f50d..da0f3a86dc4 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -24,8 +24,10 @@ The custom [Viewport] node assigned to the [CanvasLayer]. If [code]null[/code], uses the default viewport instead. + Sets the layer to follow the viewport in order to simulate a pseudo 3D effect. + Scales the layer when using [member follow_viewport_enable]. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales. Layer index for draw order. Lower values are drawn first. diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index a8ea3e1de30..a70d2caf46c 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -193,6 +193,7 @@ + Used internally by the engine. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 1f23649b751..65f6293c7c7 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -17,6 +17,7 @@ + Returns [code]true[/code] if the specified flag is enabled. @@ -25,6 +26,7 @@ + Returns the value of the specified parameter. @@ -33,6 +35,7 @@ + Returns the randomness ratio associated with the specified parameter. @@ -41,6 +44,7 @@ + Returns the [Texture] used by the specified parameter. @@ -51,6 +55,7 @@ + If [code]true[/code], enables the specified flag. See [enum Flags] for options. @@ -61,6 +66,7 @@ + Sets the specified [enum Parameter]. @@ -71,6 +77,7 @@ + Sets the randomness ratio for the specified [enum Parameter]. @@ -81,6 +88,7 @@ + Sets the [Texture] for the specified [enum Parameter]. diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index 0164943ccc7..fb48219f46d 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -170,10 +170,13 @@ + A plane that extends in the Y and Z axes. + A plane that extends in the X and Z axes. + A plane that extends in the X and Y axes. diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml index 9ffca20081a..abd9a7f6e8e 100644 --- a/doc/classes/ProceduralSky.xml +++ b/doc/classes/ProceduralSky.xml @@ -63,14 +63,19 @@ + Sky texture will be 256x128. + Sky texture will be 512x256. + Sky texture will be 1024x512. This is the default size. + Sky texture will be 2048x1024. + Sky texture will be 4096x2048. Represents the size of the [enum TextureSize] enum. diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index eeb633f480c..53ea03cd57a 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -195,6 +195,7 @@ + The identity rotation. Equivalent to an identity matrix. If a vector is transformed by an identity quaternion, it will not change. diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 0309e73eecc..53c44caed1b 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -277,7 +277,7 @@ - Changes the node's position by given offset [Vector3]. + Changes the node's position by the given offset [Vector3]. Note that the translation [code]offset[/code] is affected by the node's scale, so if scaled by e.g. [code](10, 1, 1)[/code], a translation by an offset of [code](2, 0, 0)[/code] would actually add 20 ([code]2 * 10[/code]) to the X coordinate. @@ -287,6 +287,7 @@ + Changes the node's position by the given offset [Vector3] in local space. diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 0c9ac9fbff3..c9613f25af2 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -174,6 +174,7 @@ + Commits the data to the same format used by [method ArrayMesh.add_surface_from_arrays]. This way you can further process the mesh data using the [ArrayMesh] API. @@ -197,6 +198,7 @@ + Creates a vertex array from the specified blend shape of an existing [Mesh]. This can be used to extract a specific pose from a blend shape. diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index 238d6929ba3..05ceb1cd298 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -6,6 +6,7 @@ A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control]. Textures are often created by loading them from a file. See [method @GDScript.load]. + [Texture] is a base for other resources. It cannot be used directly. @@ -24,6 +25,7 @@ + Draws the texture using a [CanvasItem] with the [VisualServer] API at the specified [code]position[/code]. Equivalent to [method VisualServer.canvas_item_add_texture_rect] with a rect at [code]position[/code] and the size of this [Texture]. @@ -42,6 +44,7 @@ + Draws the texture using a [CanvasItem] with the [VisualServer] API. Equivalent to [method VisualServer.canvas_item_add_texture_rect]. @@ -62,12 +65,14 @@ + Draws a part of the texture using a [CanvasItem] with the [VisualServer] API. Equivalent to [method VisualServer.canvas_item_add_texture_rect_region]. + Returns an [Image] with the data from this [Texture]. [Image]s can be accessed and manipulated directly. @@ -95,12 +100,13 @@ + Returns [code]true[/code] if this [Texture] has an alpha channel. - The texture's flags. + The texture's [enum Flags]. [enum Flags] are used to set various properties of the [Texture]. diff --git a/doc/classes/TextureArray.xml b/doc/classes/TextureArray.xml index 0a9ac1fb2e2..6214229f231 100644 --- a/doc/classes/TextureArray.xml +++ b/doc/classes/TextureArray.xml @@ -1,8 +1,10 @@ + Array of textures stored in a single primitive. + [TextureArray]s store an array of images in a single [Texture] primitive. Each layer of the texture array has its own mipmap chain. This makes it is a good alternative to texture atlases. diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml index 232df8f59b9..746f86dd34e 100644 --- a/doc/classes/TextureLayered.xml +++ b/doc/classes/TextureLayered.xml @@ -1,8 +1,10 @@ + Base class for 3D texture types. + Base class for [Texture3D] and [TextureArray]. Cannot be used directly. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 58dd36daa52..65191678577 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -73,6 +73,7 @@ + Returns the [enum ShadowAtlasQuadrantSubdiv] of the specified quadrant. @@ -156,12 +157,14 @@ + Attaches this [Viewport] to the root [Viewport] with the specified rectangle. This bypasses the need for another node to display this [Viewport] but makes you responsible for updating the position of this [Viewport] manually. + Stops the input from propagating further down the [SceneTree]. @@ -172,6 +175,7 @@ + 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. @@ -243,13 +247,13 @@ - If [code]true[/code], the viewport rendering will receive benefits from High Dynamic Range algorithm. + If [code]true[/code], the viewport rendering will receive benefits from High Dynamic Range algorithm. High Dynamic Range allows the viewport to receive values that are outside the 0-1 range. In Godot HDR uses 16 bits, meaning it does not store the full range of a floating point number. If [code]true[/code], the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. - The multisample anti-aliasing mode. + 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 targetting very high-end systems. If [code]true[/code], the viewport will use [World] defined in [code]world[/code] property. @@ -270,16 +274,16 @@ If [code]true[/code], the result of rendering will be flipped vertically. - The subdivision amount of first quadrant on shadow atlas. + The subdivision amount of the first quadrant on the shadow atlas. - The subdivision amount of second quadrant on shadow atlas. + The subdivision amount of the second quadrant on the shadow atlas. - The subdivision amount of third quadrant on shadow atlas. + The subdivision amount of the third quadrant on the shadow atlas. - The subdivision amount of fourth quadrant on shadow atlas. + The subdivision amount of the fourth quadrant on the shadow atlas. The shadow atlas' resolution (used for omni and spot lights). The value will be rounded up to the nearest power of 2. @@ -332,18 +336,25 @@ Always update the render target. + This quadrant will not be used. + This quadrant will only be used by one shadow map. + This quadrant will be split in 4 and used by up to 4 shadow maps. + This quadrant will be split 16 ways and used by up to 16 shadow maps. + This quadrant will be split 64 ways and used by up to 64 shadow maps. + 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. + 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. Represents the size of the [enum ShadowAtlasQuadrantSubdiv] enum. @@ -385,20 +396,28 @@ Multisample anti-aliasing mode disabled. This is the default value. + Use 2x Multisample Antialiasing. + Use 4x Multisample Antialiasing. + Use 8x Multisample Antialiasing. Likely unsupported on low-end and older hardware. + Use 16x Multisample Antialiasing. Likely unsupported on medium and low-end hardware. + Allocates all buffers needed for drawing 2D scenes. This takes less VRAM than the 3D usage modes. + Allocates buffers needed for 2D scenes without allocating a buffer for screen copy. Accordingly, you cannot read from the screen. Of the [enum Usage] types, this requires the least VRAM. + Allocates full buffers for drawing 3D scenes and all 3D effects including buffers needed for 2D scenes and effects. + Allocates buffers needed for drawing 3D scenes. But does not allocate buffers needed for reading from the screen and post-processing effects. Saves some VRAM. Always clear the render target before drawing. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index dd87c53c3cb..db0eb798137 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -3897,7 +3897,7 @@ - Copies viewport to a region of the screen specified by [code]rect[/code]. If Viewport.[member Viewport.render_direct_to_screen] is [code]true[/code], then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. + Copies viewport to a region of the screen specified by [code]rect[/code]. If [member Viewport.render_direct_to_screen] is [code]true[/code], then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. For example, you can set the root viewport to not render at all with the following code: [codeblock] func _ready(): diff --git a/modules/opensimplex/doc_classes/NoiseTexture.xml b/modules/opensimplex/doc_classes/NoiseTexture.xml index 07d5eb27d61..8be037b5a28 100644 --- a/modules/opensimplex/doc_classes/NoiseTexture.xml +++ b/modules/opensimplex/doc_classes/NoiseTexture.xml @@ -16,6 +16,7 @@ If [code]true[/code], the resulting texture contains a normal map created from the original noise interpreted as a bump map. + Strength of the bump maps used in this texture. A higher value will make the bump maps appear larger while a lower value will make them appear softer.