From 46b594054c8f7118e21ab17e078b3ee4b0730a19 Mon Sep 17 00:00:00 2001
From: Rémi Verschelde
Date: Thu, 22 Feb 2018 19:02:37 +0100
Subject: doc: Sync classref with current source
---
doc/classes/VisualServer.xml | 2238 ++++++++++++++++++++++++++++++++++++++----
1 file changed, 2044 insertions(+), 194 deletions(-)
(limited to 'doc/classes/VisualServer.xml')
diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml
index a546b86c5..9d37fb028 100644
--- a/doc/classes/VisualServer.xml
+++ b/doc/classes/VisualServer.xml
@@ -42,6 +42,80 @@
Sets margin size, where black bars (or images, if [method black_bars_set_images] was used) are rendered.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -881,6 +955,12 @@
Modulates all colors in the given canvas.
+
+
+
+
+
+
@@ -890,455 +970,2049 @@
Draws a frame.
-
-
+
+
- Removes buffers and clears testcubes.
-
+
-
+
+
+
+
+
+
+
+
+
+
+
- Draws a frame. Same as [method draw].
-
+
+
+
+
+
+
+
+
+
- Syncronizes threads.
-
+
-
+
+
+
- Tries to free an object in the VisualServer.
-
-
+
+
-
+
+
+
- Returns a certain information, see RENDER_INFO_* for options.
-
-
+
+
+
+
+
+
- Returns the id of the test cube. Creates one if none exists.
-
-
+
+
+
+
+
+
- Returns the id of the test texture. Creates one if none exists.
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Returns the id of a white texture. Creates one if none exists.
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Returns [code]true[/code] if changes have been made to the VisualServer's data. [method draw] is usually called if this happens.
-
-
+
+
-
+
+
+
+
+
+
+
+
+
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
- Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc,
-
+
+
+
+
+
+
+
+
+
+
+
- Initializes the visual server.
-
-
+
+
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
-
-
+
+
+
+
+
+
- Returns an empty material.
-
-
+
+
-
+
-
+
- Returns the value of a certain material's parameter.
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader.
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
- Sets a materials line width.
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Sets an objects next material.
-
+
-
-
-
-
-
+
+ Removes buffers and clears testcubes.
+
+
+
+
+
+
- Sets a materials parameter.
+ Draws a frame. Same as [method draw].
-
+
-
+
+ Syncronizes threads.
+
+
+
+
+
+
-
+
+ Tries to free an object in the VisualServer.
+
+
+
+
+
+
+
+
+ Returns a certain information, see RENDER_INFO_* for options.
+
+
+
+
+
+
+ Returns the id of the test cube. Creates one if none exists.
+
+
+
+
+
+
+ Returns the id of the test texture. Creates one if none exists.
+
+
+
+
+
+
+ Returns the id of a white texture. Creates one if none exists.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns [code]true[/code] if changes have been made to the VisualServer's data. [method draw] is usually called if this happens.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Initializes the visual server.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
+
+
+
+
+
+
+ Returns an empty material.
+
+
+
+
+
+
+
+
+
+
+ Returns the value of a certain material's parameter.
+
+
+
+
+
+
+
+
+ Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader.
+
+
+
+
+
+
+
+
+
+
+ Sets a materials line width.
+
+
+
+
+
+
+
+
+
+
+ Sets an objects next material.
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets a materials parameter.
+
+
+
+
+
+
+
+
+
+
+ Sets a material's render priority.
+
+
+
+
+
+
+
+
+
+
+ Sets a shader material's shader.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE_* constants for types.
+
+
+
+
+
+
+
+
+ Removes all surfaces from a mesh.
+
+
+
+
+
+
+ Creates a new mesh.
+
+
+
+
+
+
+
+
+ Returns a mesh's blend shape count.
+
+
+
+
+
+
+
+
+ Returns a mesh's blend shape mode.
+
+
+
+
+
+
+
+
+ Returns a mesh's custom aabb.
+
+
+
+
+
+
+
+
+ Returns a mesh's number of surfaces.
+
+
+
+
+
+
+
+
+
+
+ Removes a mesh's surface.
+
+
+
+
+
+
+
+
+
+
+ Sets a mesh's blend shape count.
+
+
+
+
+
+
+
+
+
+
+ Sets a mesh's blend shape mode.
+
+
+
+
+
+
+
+
+
+
+ Sets a mesh's custom aabb.
+
+
+
+
+
+
+
+
+
+
+ Returns a mesh's surface's aabb.
+
+
+
+
+
+
+
+
+
+
+ Returns a mesh's surface's vertex buffer.
+
+
+
+
+
+
+
+
+
+
+ Returns a mesh's surface's amount of indices.
+
+
+
+
+
+
+
+
+
+
+ Returns a mesh's surface's amount of vertices.
+
+
+
+
+
+
+
+
+
+
+ Returns a mesh's surface's buffer arrays.
+
+
+
+
+
+
+
+
+
+
+ Returns a mesh's surface's arrays for blend shapes
+
+
+
+
+
+
+
+
+
+
+ Returns the format of a mesh's surface.
+
+
+
+
+
+
+
+
+
+
+ Returns a mesh's surface's index buffer.
+
+
+
+
+
+
+
+
+
+
+ Returns a mesh's surface's material.
+
+
+
+
+
+
+
+
+
+
+ Returns the primitive type of a mesh's surface.
+
+
+
+
+
+
+
+
+
+
+ Returns the aabb of a mesh's surface's skeleton.
+
+
+
+
+
+
+
+
+
+
+
+
+ Sets a mesh's surface's material.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Sets a material's render priority.
-
+
-
+
-
+
- Sets a shader material's shader.
-
+
-
-
-
-
-
-
-
+
-
+
- Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE_* constants for types.
-
+
-
+
+
+
- Removes all surfaces from a mesh.
-
-
+
+
+
+
+
+
- Creates a new mesh.
-
-
+
+
-
+
+
+
- Returns a mesh's blend shape count.
-
-
+
+
-
+
+
+
- Returns a mesh's blend shape mode.
-
-
+
+
-
-
- Returns a mesh's custom aabb.
-
-
+
+
-
+
+
+
- Returns a mesh's number of surfaces.
-
+
-
+
-
+
- Removes a mesh's surface.
-
+
-
+
-
+
- Sets a mesh's blend shape count.
-
+
-
+
-
+
- Sets a mesh's blend shape mode.
-
+
-
+
-
+
- Sets a mesh's custom aabb.
-
-
+
+
-
+
-
+
- Returns a mesh's surface's aabb.
-
-
+
+
-
+
-
+
- Returns a mesh's surface's vertex buffer.
-
-
+
+
-
+
-
+
- Returns a mesh's surface's amount of indices.
-
-
+
+
-
+
-
+
- Returns a mesh's surface's amount of vertices.
-
-
+
+
-
+
-
+
- Returns a mesh's surface's buffer arrays.
-
-
+
+
-
+
-
+
- Returns a mesh's surface's arrays for blend shapes
-
-
+
+
-
+
-
+
- Returns the format of a mesh's surface.
-
-
+
+
-
+
-
+
+
+
- Returns a mesh's surface's index buffer.
+ Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn.
+ The callback method must use only 1 argument which will be called with 'userdata'.
-
+
-
-
-
-
- Returns a mesh's surface's material.
-
-
+
+
-
+
-
+
- Returns the primitive type of a mesh's surface.
-
-
+
+
-
+
-
+
- Returns the aabb of a mesh's surface's skeleton.
-
+
-
+
-
-
-
+
- Sets a mesh's surface's material.
-
+
-
+
-
+
-
+
- Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn.
- The callback method must use only 1 argument which will be called with 'userdata'.
@@ -1430,6 +3104,76 @@
Sets a shader's default texture. Overwrites the texture given by name.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1450,6 +3194,12 @@
Sets a sky's texture.
+
+
+
+
+
+
@@ -2214,6 +3964,24 @@
The light parameters endpoint. Used internally.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2323,6 +4091,18 @@
A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
+
+
+
+
+
+
+
+
+
+
+
+
The nine patch gets stretched where needed.
@@ -2398,5 +4178,75 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
--
cgit v1.2.3-70-g09d2