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

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-06-16 11:23:24 +02:00
parent 5c4340d30c
commit eef7baf24c
19 changed files with 501 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
classes/class_@globalscope.rst
View File

@@ -22,6 +22,8 @@ Properties
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`AudioServer<class_AudioServer>` | :ref:`AudioServer<class_@GlobalScope_property_AudioServer>` |
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`CameraServer<class_CameraServer>` | :ref:`CameraServer<class_@GlobalScope_property_CameraServer>` |
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`ClassDB<class_ClassDB>` | :ref:`ClassDB<class_@GlobalScope_property_ClassDB>` |
+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`Engine<class_Engine>` | :ref:`Engine<class_@GlobalScope_property_Engine>` |
@@ -2147,6 +2149,12 @@ Property Descriptions
:ref:`AudioServer<class_AudioServer>` singleton
.. _class_@GlobalScope_property_CameraServer:
- :ref:`CameraServer<class_CameraServer>` **CameraServer**
:ref:`CameraServer<class_CameraServer>` singleton
.. _class_@GlobalScope_property_ClassDB:
- :ref:`ClassDB<class_ClassDB>` **ClassDB**

2
classes/class_animationnode.rst
View File

@@ -79,6 +79,8 @@ Called when the node was removed from the graph.
- **tree_changed** **(** **)**
Emitted by nodes that inherit from this class and that have an internal tree when one of their nodes changes. The nodes that emit this signal are :ref:`AnimationNodeBlendSpace1D<class_AnimationNodeBlendSpace1D>`, :ref:`AnimationNodeBlendSpace2D<class_AnimationNodeBlendSpace2D>`, :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>`, and :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
Enumerations
------------

9
classes/class_animationnodeadd2.rst
View File

@@ -14,7 +14,7 @@ AnimationNodeAdd2
Brief Description
-----------------
Blends two animations additively inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
Properties
----------
@@ -23,6 +23,11 @@ Properties
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd2_property_sync>` |
+-------------------------+----------------------------------------------------+
Description
-----------
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations additively based on an amount value in the ``[0.0, 1.0]`` range.
Property Descriptions
---------------------
@@ -36,3 +41,5 @@ Property Descriptions
| *Getter* | is_using_sync() |
+----------+---------------------+
If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input<class_AnimationNode_method_blend_input>`, forcing the blended animations to update every frame.

17
classes/class_animationnodeadd3.rst
View File

@@ -14,7 +14,7 @@ AnimationNodeAdd3
Brief Description
-----------------
Blends two of three animations additively inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
Properties
----------
@@ -23,6 +23,19 @@ Properties
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeAdd3_property_sync>` |
+-------------------------+----------------------------------------------------+
Description
-----------
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations together additively out of three based on a value in the ``[-1.0, 1.0]`` range.
This node has three inputs:
- The base animation to add to
- A -add animation to blend with when the blend amount is in the ``[-1.0, 0.0]`` range.
- A +add animation to blend with when the blend amount is in the ``[0.0, 1.0]`` range
Property Descriptions
---------------------
@@ -36,3 +49,5 @@ Property Descriptions
| *Getter* | is_using_sync() |
+----------+---------------------+
If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input<class_AnimationNode_method_blend_input>`, forcing the blended animations to update every frame.

9
classes/class_animationnodeanimation.rst
View File

@@ -14,7 +14,7 @@ AnimationNodeAnimation
Brief Description
-----------------
Input animation to use in an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
Properties
----------
@@ -23,6 +23,11 @@ Properties
| :ref:`String<class_String>` | :ref:`animation<class_AnimationNodeAnimation_property_animation>` |
+-----------------------------+-------------------------------------------------------------------+
Description
-----------
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Only features one output set using the :ref:`animation<class_AnimationNodeAnimation_property_animation>` property. Use it as an input for :ref:`AnimationNode<class_AnimationNode>` that blend animations together.
Property Descriptions
---------------------
@@ -36,3 +41,5 @@ Property Descriptions
| *Getter* | get_animation() |
+----------+----------------------+
Animation to use as an output. It is one of the animations provided by :ref:`AnimationTree.anim_player<class_AnimationTree_property_anim_player>`.

9
classes/class_animationnodeblend2.rst
View File

@@ -14,7 +14,7 @@ AnimationNodeBlend2
Brief Description
-----------------
Blends two animations linearly inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
Properties
----------
@@ -23,6 +23,11 @@ Properties
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend2_property_sync>` |
+-------------------------+------------------------------------------------------+
Description
-----------
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations linearly based on an amount value in the ``[0.0, 1.0]`` range.
Property Descriptions
---------------------
@@ -36,3 +41,5 @@ Property Descriptions
| *Getter* | is_using_sync() |
+----------+---------------------+
If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input<class_AnimationNode_method_blend_input>`, forcing the blended animations to update every frame.

17
classes/class_animationnodeblend3.rst
View File

@@ -14,7 +14,7 @@ AnimationNodeBlend3
Brief Description
-----------------
Blends two of three animations linearly inside of an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
Properties
----------
@@ -23,6 +23,19 @@ Properties
| :ref:`bool<class_bool>` | :ref:`sync<class_AnimationNodeBlend3_property_sync>` |
+-------------------------+------------------------------------------------------+
Description
-----------
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations together linearly out of three based on a value in the ``[-1.0, 1.0]`` range.
This node has three inputs:
- The base animation
- A -blend animation to blend with when the blend amount is in the ``[-1.0, 0.0]`` range.
- A +blend animation to blend with when the blend amount is in the ``[0.0, 1.0]`` range
Property Descriptions
---------------------
@@ -36,3 +49,5 @@ Property Descriptions
| *Getter* | is_using_sync() |
+----------+---------------------+
If ``true``, sets the ``optimization`` to ``false`` when calling :ref:`AnimationNode.blend_input<class_AnimationNode_method_blend_input>`, forcing the blended animations to update every frame.

35
classes/class_animationnodeblendspace1d.rst
View File

@@ -14,7 +14,7 @@ AnimationNodeBlendSpace1D
Brief Description
-----------------
Blends linearly between two of any number of :ref:`AnimationNode<class_AnimationNode>` of any type placed on a virtual axis.
Properties
----------
@@ -48,6 +48,17 @@ Methods
| void | :ref:`set_blend_point_position<class_AnimationNodeBlendSpace1D_method_set_blend_point_position>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)** |
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
This is a virtual axis on which you can add any type of :ref:`AnimationNode<class_AnimationNode>` using :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
Outputs the linear blend of the two ``AnimationNode`` closest to the node's current ``value``.
You can set the extents of the axis using the :ref:`min_space<class_AnimationNodeBlendSpace1D_property_min_space>` and :ref:`max_space<class_AnimationNodeBlendSpace1D_property_max_space>`.
Property Descriptions
---------------------
@@ -61,6 +72,8 @@ Property Descriptions
| *Getter* | get_max_space() |
+----------+----------------------+
The blend space's axis's upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
.. _class_AnimationNodeBlendSpace1D_property_min_space:
- :ref:`float<class_float>` **min_space**
@@ -71,6 +84,8 @@ Property Descriptions
| *Getter* | get_min_space() |
+----------+----------------------+
The blend space's axis's lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace1D_method_add_blend_point>`.
.. _class_AnimationNodeBlendSpace1D_property_snap:
- :ref:`float<class_float>` **snap**
@@ -81,6 +96,8 @@ Property Descriptions
| *Getter* | get_snap() |
+----------+-----------------+
Position increment to snap to when moving a point on the axis.
.. _class_AnimationNodeBlendSpace1D_property_value_label:
- :ref:`String<class_String>` **value_label**
@@ -91,6 +108,8 @@ Property Descriptions
| *Getter* | get_value_label() |
+----------+------------------------+
Label of the virtual axis of the blend space.
Method Descriptions
-------------------
@@ -98,27 +117,41 @@ Method Descriptions
- void **add_blend_point** **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`float<class_float>` pos, :ref:`int<class_int>` at_index=-1 **)**
Add a new point that represents a ``node`` on the virtual axis at a given position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array.
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_count:
- :ref:`int<class_int>` **get_blend_point_count** **(** **)** const
Returns the number of points on the blend axis.
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_node:
- :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const
Returns the ``AnimationNode`` referenced by the point at index ``point``.
.. _class_AnimationNodeBlendSpace1D_method_get_blend_point_position:
- :ref:`float<class_float>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const
Returns the position of the point at index ``point``.
.. _class_AnimationNodeBlendSpace1D_method_remove_blend_point:
- void **remove_blend_point** **(** :ref:`int<class_int>` point **)**
Removes the point at index ``point`` from the blend axis.
.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_node:
- void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**
Changes the AnimationNode referenced by the point at index ``point``.
.. _class_AnimationNodeBlendSpace1D_method_set_blend_point_position:
- void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` pos **)**
Updates the position of the point at index ``point`` on the blend axis.

55
classes/class_animationnodeblendspace2d.rst
View File

@@ -14,7 +14,7 @@ AnimationNodeBlendSpace2D
Brief Description
-----------------
Blends linearly between three :ref:`AnimationNode<class_AnimationNode>` of any type placed in a 2d space.
Properties
----------
@@ -69,6 +69,8 @@ Signals
- **triangles_updated** **(** **)**
Emitted every time the blend space's triangles are created, removed, or when one of their vertices changes position.
Enumerations
------------
@@ -82,11 +84,20 @@ Enumerations
enum **BlendMode**:
- **BLEND_MODE_INTERPOLATED** = **0**
- **BLEND_MODE_INTERPOLATED** = **0** --- The interpolation between animations is linear.
- **BLEND_MODE_DISCRETE** = **1** --- Useful for frame-by-frame 2D animations.
- **BLEND_MODE_DISCRETE** = **1** --- The blend space plays the animation of the node the blending position is closest to. Useful for frame-by-frame 2D animations.
- **BLEND_MODE_DISCRETE_CARRY** = **2** --- Keep the current play position when switching between discrete animations.
- **BLEND_MODE_DISCRETE_CARRY** = **2** --- Similar to :ref:`BLEND_MODE_DISCRETE<class_AnimationNodeBlendSpace2D_constant_BLEND_MODE_DISCRETE>`, but starts the new animation at the last animation's playback position.
Description
-----------
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`.
This node allows you to blend linearly between three animations using a :ref:`Vector2<class_Vector2>` weight.
You can add vertices to the blend space with :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>` and automatically triangulate it by setting :ref:`auto_triangles<class_AnimationNodeBlendSpace2D_property_auto_triangles>` to ``true``. Otherwise, use :ref:`add_triangle<class_AnimationNodeBlendSpace2D_method_add_triangle>` and :ref:`remove_triangle<class_AnimationNodeBlendSpace2D_method_remove_triangle>` to create up the blend space by hand.
Property Descriptions
---------------------
@@ -101,6 +112,8 @@ Property Descriptions
| *Getter* | get_auto_triangles() |
+----------+---------------------------+
If true, the blend space is triangulated automatically. The mesh updates every time you add or remove points with :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>` and :ref:`remove_blend_point<class_AnimationNodeBlendSpace2D_method_remove_blend_point>`.
.. _class_AnimationNodeBlendSpace2D_property_blend_mode:
- :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` **blend_mode**
@@ -111,6 +124,8 @@ Property Descriptions
| *Getter* | get_blend_mode() |
+----------+-----------------------+
Controls the interpolation between animations. See :ref:`BlendMode<enum_AnimationNodeBlendSpace2D_BlendMode>` constants.
.. _class_AnimationNodeBlendSpace2D_property_max_space:
- :ref:`Vector2<class_Vector2>` **max_space**
@@ -121,6 +136,8 @@ Property Descriptions
| *Getter* | get_max_space() |
+----------+----------------------+
The blend space's X and Y axes' upper limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>`.
.. _class_AnimationNodeBlendSpace2D_property_min_space:
- :ref:`Vector2<class_Vector2>` **min_space**
@@ -131,6 +148,8 @@ Property Descriptions
| *Getter* | get_min_space() |
+----------+----------------------+
The blend space's X and Y axes' lower limit for the points' position. See :ref:`add_blend_point<class_AnimationNodeBlendSpace2D_method_add_blend_point>`.
.. _class_AnimationNodeBlendSpace2D_property_snap:
- :ref:`Vector2<class_Vector2>` **snap**
@@ -141,6 +160,8 @@ Property Descriptions
| *Getter* | get_snap() |
+----------+-----------------+
Position increment to snap to when moving a point.
.. _class_AnimationNodeBlendSpace2D_property_x_label:
- :ref:`String<class_String>` **x_label**
@@ -151,6 +172,8 @@ Property Descriptions
| *Getter* | get_x_label() |
+----------+--------------------+
Name of the blend space's X axis.
.. _class_AnimationNodeBlendSpace2D_property_y_label:
- :ref:`String<class_String>` **y_label**
@@ -161,6 +184,8 @@ Property Descriptions
| *Getter* | get_y_label() |
+----------+--------------------+
Name of the blend space's Y axis.
Method Descriptions
-------------------
@@ -168,43 +193,65 @@ Method Descriptions
- void **add_blend_point** **(** :ref:`AnimationRootNode<class_AnimationRootNode>` node, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` at_index=-1 **)**
Add a new point that represents a ``node`` at the position set by ``pos``. You can insert it at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array.
.. _class_AnimationNodeBlendSpace2D_method_add_triangle:
- void **add_triangle** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` at_index=-1 **)**
Creates a new triangle using three points ``x``, ``y``, and ``z``. Triangles can overlap. You can insert the triangle at a specific index using the ``at_index`` argument. If you use the default value for ``at_index`` , the point is inserted at the end of the blend points array.
.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_count:
- :ref:`int<class_int>` **get_blend_point_count** **(** **)** const
Returns the number of points in the blend space.
.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_node:
- :ref:`AnimationRootNode<class_AnimationRootNode>` **get_blend_point_node** **(** :ref:`int<class_int>` point **)** const
Returns the ``AnimationRootNode`` referenced by the point at index ``point``.
.. _class_AnimationNodeBlendSpace2D_method_get_blend_point_position:
- :ref:`Vector2<class_Vector2>` **get_blend_point_position** **(** :ref:`int<class_int>` point **)** const
Returns the position of the point at index ``point``.
.. _class_AnimationNodeBlendSpace2D_method_get_triangle_count:
- :ref:`int<class_int>` **get_triangle_count** **(** **)** const
Returns the number of triangles in the blend space.
.. _class_AnimationNodeBlendSpace2D_method_get_triangle_point:
- :ref:`int<class_int>` **get_triangle_point** **(** :ref:`int<class_int>` triangle, :ref:`int<class_int>` point **)**
Returns the position of the point at index ``point`` in the triangle of index ``triangle``.
.. _class_AnimationNodeBlendSpace2D_method_remove_blend_point:
- void **remove_blend_point** **(** :ref:`int<class_int>` point **)**
Removes the point at index ``point`` from the blend space.
.. _class_AnimationNodeBlendSpace2D_method_remove_triangle:
- void **remove_triangle** **(** :ref:`int<class_int>` triangle **)**
Removes the triangle at index ``triangle`` from the blend space.
.. _class_AnimationNodeBlendSpace2D_method_set_blend_point_node:
- void **set_blend_point_node** **(** :ref:`int<class_int>` point, :ref:`AnimationRootNode<class_AnimationRootNode>` node **)**
Changes the AnimationNode referenced by the point at index ``point``.
.. _class_AnimationNodeBlendSpace2D_method_set_blend_point_position:
- void **set_blend_point_position** **(** :ref:`int<class_int>` point, :ref:`Vector2<class_Vector2>` pos **)**
Updates the position of the point at index ``point`` on the blend axis.

8
classes/class_arvrinterface.rst
View File

@@ -32,6 +32,8 @@ Properties
Methods
-------
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_camera_feed_id<class_ARVRInterface_method_get_camera_feed_id>` **(** **)** |
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_capabilities<class_ARVRInterface_method_get_capabilities>` **(** **)** const |
+------------------------------------------------------------+----------------------------------------------------------------------------------------------+
@@ -164,6 +166,12 @@ Is this our primary interface?
Method Descriptions
-------------------
.. _class_ARVRInterface_method_get_camera_feed_id:
- :ref:`int<class_int>` **get_camera_feed_id** **(** **)**
If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed id in the :ref:`CameraServer<class_CameraServer>` for this interface.
.. _class_ARVRInterface_method_get_capabilities:
- :ref:`int<class_int>` **get_capabilities** **(** **)** const

128
classes/class_camerafeed.rst Normal file
View File

@@ -0,0 +1,128 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CameraFeed.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CameraFeed:
CameraFeed
==========
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
A camera feed gives you access to a single physical camera attached to your device.
Properties
----------
+---------------------------------------+-----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`feed_is_active<class_CameraFeed_property_feed_is_active>` |
+---------------------------------------+-----------------------------------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`feed_transform<class_CameraFeed_property_feed_transform>` |
+---------------------------------------+-----------------------------------------------------------------+
Methods
-------
+---------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_id<class_CameraFeed_method_get_id>` **(** **)** const |
+---------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_name<class_CameraFeed_method_get_name>` **(** **)** const |
+---------------------------------------------------+-----------------------------------------------------------------------------+
| :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` | :ref:`get_position<class_CameraFeed_method_get_position>` **(** **)** const |
+---------------------------------------------------+-----------------------------------------------------------------------------+
Enumerations
------------
.. _enum_CameraFeed_FeedDataType:
.. _class_CameraFeed_constant_FEED_NOIMAGE:
.. _class_CameraFeed_constant_FEED_RGB:
.. _class_CameraFeed_constant_FEED_YCbCr:
.. _class_CameraFeed_constant_FEED_YCbCr_Sep:
enum **FeedDataType**:
- **FEED_NOIMAGE** = **0** --- No image set for the feed.
- **FEED_RGB** = **1** --- Feed supplies RGB images.
- **FEED_YCbCr** = **2** --- Feed supplies YCbCr images that need to be converted to RGB.
- **FEED_YCbCr_Sep** = **3** --- Feed supplies separate Y and CbCr images that need to be combined and converted to RGB.
.. _enum_CameraFeed_FeedPosition:
.. _class_CameraFeed_constant_FEED_UNSPECIFIED:
.. _class_CameraFeed_constant_FEED_FRONT:
.. _class_CameraFeed_constant_FEED_BACK:
enum **FeedPosition**:
- **FEED_UNSPECIFIED** = **0** --- Unspecified position.
- **FEED_FRONT** = **1** --- Camera is mounted at the front of the device.
- **FEED_BACK** = **2** --- Camera is moutned at the back of the device.
Description
-----------
A camera feed gives you access to a single physical camera attached to your device.
When enabled Godot will start capturing frames from the camera which can then be used. Do note that many cameras will return YCbCr images which are split into two textures and need to be combined in a shader. Godot does this automatically for you if you set the environment to show the camera image in the background.
Property Descriptions
---------------------
.. _class_CameraFeed_property_feed_is_active:
- :ref:`bool<class_bool>` **feed_is_active**
+----------+-------------------+
| *Setter* | set_active(value) |
+----------+-------------------+
| *Getter* | is_active() |
+----------+-------------------+
.. _class_CameraFeed_property_feed_transform:
- :ref:`Transform2D<class_Transform2D>` **feed_transform**
+----------+----------------------+
| *Setter* | set_transform(value) |
+----------+----------------------+
| *Getter* | get_transform() |
+----------+----------------------+
Method Descriptions
-------------------
.. _class_CameraFeed_method_get_id:
- :ref:`int<class_int>` **get_id** **(** **)** const
Get unique id for this feed
.. _class_CameraFeed_method_get_name:
- :ref:`String<class_String>` **get_name** **(** **)** const
Get name of the camera
.. _class_CameraFeed_method_get_position:
- :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` **get_position** **(** **)** const
Position of camera on the device.

104
classes/class_cameraserver.rst Normal file
View File

@@ -0,0 +1,104 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CameraServer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CameraServer:
CameraServer
============
**Inherits:** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Our camera server keeps track of different cameras accessible in Godot. These are external cameras such as webcams or the cameras on your phone.
Methods
-------
+-------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_feed<class_CameraServer_method_add_feed>` **(** :ref:`CameraFeed<class_CameraFeed>` feed **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`feeds<class_CameraServer_method_feeds>` **(** **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`CameraFeed<class_CameraFeed>` | :ref:`get_feed<class_CameraServer_method_get_feed>` **(** :ref:`int<class_int>` index **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_feed_count<class_CameraServer_method_get_feed_count>` **(** **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_feed<class_CameraServer_method_remove_feed>` **(** :ref:`CameraFeed<class_CameraFeed>` feed **)** |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_CameraServer_signal_camera_feed_added:
- **camera_feed_added** **(** :ref:`int<class_int>` id **)**
Emitted when a :ref:`CameraFeed<class_CameraFeed>` is added (webcam is plugged in).
.. _class_CameraServer_signal_camera_feed_removed:
- **camera_feed_removed** **(** :ref:`int<class_int>` id **)**
Emitted when a :ref:`CameraFeed<class_CameraFeed>` is removed (webcam is removed).
Enumerations
------------
.. _enum_CameraServer_FeedImage:
.. _class_CameraServer_constant_FEED_RGBA_IMAGE:
.. _class_CameraServer_constant_FEED_YCbCr_IMAGE:
.. _class_CameraServer_constant_FEED_Y_IMAGE:
.. _class_CameraServer_constant_FEED_CbCr_IMAGE:
enum **FeedImage**:
- **FEED_RGBA_IMAGE** = **0** --- The RGBA camera image.
- **FEED_YCbCr_IMAGE** = **0** --- The YCbCr camera image.
- **FEED_Y_IMAGE** = **0** --- The Y component camera image.
- **FEED_CbCr_IMAGE** = **1** --- The CbCr component camera image.
Method Descriptions
-------------------
.. _class_CameraServer_method_add_feed:
- void **add_feed** **(** :ref:`CameraFeed<class_CameraFeed>` feed **)**
Adds a camera feed to the camera server.
.. _class_CameraServer_method_feeds:
- :ref:`Array<class_Array>` **feeds** **(** **)**
Returns an array of :ref:`CameraFeed<class_CameraFeed>`\ s.
.. _class_CameraServer_method_get_feed:
- :ref:`CameraFeed<class_CameraFeed>` **get_feed** **(** :ref:`int<class_int>` index **)**
Returns the :ref:`CameraFeed<class_CameraFeed>` with this id.
.. _class_CameraServer_method_get_feed_count:
- :ref:`int<class_int>` **get_feed_count** **(** **)**
Returns the number of :ref:`CameraFeed<class_CameraFeed>`\ s registered.
.. _class_CameraServer_method_remove_feed:
- void **remove_feed** **(** :ref:`CameraFeed<class_CameraFeed>` feed **)**
Removes a :ref:`CameraFeed<class_CameraFeed>`.

68
classes/class_cameratexture.rst Normal file
View File

@@ -0,0 +1,68 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CameraTexture.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CameraTexture:
CameraTexture
=============
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
This texture gives access to the camera texture provided by a :ref:`CameraFeed<class_CameraFeed>`. Note that many cameras supply YCbCr images which need to be converted in a shader.
Properties
----------
+-----------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` |
+-----------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` |
+-----------------------------------------------+------------------------------------------------------------------------+
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` |
+-----------------------------------------------+------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_CameraTexture_property_camera_feed_id:
- :ref:`int<class_int>` **camera_feed_id**
+----------+---------------------------+
| *Setter* | set_camera_feed_id(value) |
+----------+---------------------------+
| *Getter* | get_camera_feed_id() |
+----------+---------------------------+
Id of the :ref:`CameraFeed<class_CameraFeed>` for which we want to display the image.
.. _class_CameraTexture_property_camera_is_active:
- :ref:`bool<class_bool>` **camera_is_active**
+----------+--------------------------+
| *Setter* | set_camera_active(value) |
+----------+--------------------------+
| *Getter* | get_camera_active() |
+----------+--------------------------+
Convenience property that gives access to the active property of the :ref:`CameraFeed<class_CameraFeed>`.
.. _class_CameraTexture_property_which_feed:
- :ref:`FeedImage<enum_CameraServer_FeedImage>` **which_feed**
+----------+-----------------------+
| *Setter* | set_which_feed(value) |
+----------+-----------------------+
| *Getter* | get_which_feed() |
+----------+-----------------------+
Which image within the :ref:`CameraFeed<class_CameraFeed>` we want access to, important if the camera image is split in a Y and CbCr component.

20
classes/class_environment.rst
View File

@@ -46,6 +46,8 @@ Properties
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`auto_exposure_speed<class_Environment_property_auto_exposure_speed>` |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`background_camera_feed_id<class_Environment_property_background_camera_feed_id>` |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`background_canvas_max_layer<class_Environment_property_background_canvas_max_layer>` |
+--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`background_color<class_Environment_property_background_color>` |
@@ -204,6 +206,8 @@ Enumerations
.. _class_Environment_constant_BG_CANVAS:
.. _class_Environment_constant_BG_CAMERA_FEED:
.. _class_Environment_constant_BG_MAX:
enum **BGMode**:
@@ -220,7 +224,9 @@ enum **BGMode**:
- **BG_CANVAS** = **4** --- Display a :ref:`CanvasLayer<class_CanvasLayer>` in the background.
- **BG_MAX** = **6** --- Helper constant keeping track of the enum's size, has no direct usage in API calls.
- **BG_CAMERA_FEED** = **6** --- Display a camera feed in the background.
- **BG_MAX** = **7** --- Helper constant keeping track of the enum's size, has no direct usage in API calls.
.. _enum_Environment_GlowBlendMode:
@@ -495,6 +501,18 @@ Scale of the auto exposure effect. Affects the intensity of auto exposure.
Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.
.. _class_Environment_property_background_camera_feed_id:
- :ref:`int<class_int>` **background_camera_feed_id**
+----------+---------------------------+
| *Setter* | set_camera_feed_id(value) |
+----------+---------------------------+
| *Getter* | get_camera_feed_id() |
+----------+---------------------------+
The id of the camera feed to show in the background.
.. _class_Environment_property_background_canvas_max_layer:
- :ref:`int<class_int>` **background_canvas_max_layer**

2
classes/class_object.rst
View File

@@ -7,7 +7,7 @@
Object
======
**Inherited By:** :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>`, :ref:`ARVRServer<class_ARVRServer>`, :ref:`AudioServer<class_AudioServer>`, :ref:`ClassDB<class_ClassDB>`, :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>`, :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>`, :ref:`EditorSelection<class_EditorSelection>`, :ref:`Engine<class_Engine>`, :ref:`Geometry<class_Geometry>`, :ref:`GodotSharp<class_GodotSharp>`, :ref:`IP<class_IP>`, :ref:`Input<class_Input>`, :ref:`InputMap<class_InputMap>`, :ref:`JSON<class_JSON>`, :ref:`JavaScript<class_JavaScript>`, :ref:`MainLoop<class_MainLoop>`, :ref:`Node<class_Node>`, :ref:`OS<class_OS>`, :ref:`Performance<class_Performance>`, :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>`, :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>`, :ref:`Physics2DServer<class_Physics2DServer>`, :ref:`PhysicsDirectBodyState<class_PhysicsDirectBodyState>`, :ref:`PhysicsDirectSpaceState<class_PhysicsDirectSpaceState>`, :ref:`PhysicsServer<class_PhysicsServer>`, :ref:`ProjectSettings<class_ProjectSettings>`, :ref:`Reference<class_Reference>`, :ref:`ResourceLoader<class_ResourceLoader>`, :ref:`ResourceSaver<class_ResourceSaver>`, :ref:`TranslationServer<class_TranslationServer>`, :ref:`TreeItem<class_TreeItem>`, :ref:`UndoRedo<class_UndoRedo>`, :ref:`VisualScriptEditor<class_VisualScriptEditor>`, :ref:`VisualServer<class_VisualServer>`
**Inherited By:** :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>`, :ref:`ARVRServer<class_ARVRServer>`, :ref:`AudioServer<class_AudioServer>`, :ref:`CameraServer<class_CameraServer>`, :ref:`ClassDB<class_ClassDB>`, :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>`, :ref:`EditorNavigationMeshGenerator<class_EditorNavigationMeshGenerator>`, :ref:`EditorSelection<class_EditorSelection>`, :ref:`Engine<class_Engine>`, :ref:`Geometry<class_Geometry>`, :ref:`GodotSharp<class_GodotSharp>`, :ref:`IP<class_IP>`, :ref:`Input<class_Input>`, :ref:`InputMap<class_InputMap>`, :ref:`JSON<class_JSON>`, :ref:`JavaScript<class_JavaScript>`, :ref:`MainLoop<class_MainLoop>`, :ref:`Node<class_Node>`, :ref:`OS<class_OS>`, :ref:`Performance<class_Performance>`, :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>`, :ref:`Physics2DDirectSpaceState<class_Physics2DDirectSpaceState>`, :ref:`Physics2DServer<class_Physics2DServer>`, :ref:`PhysicsDirectBodyState<class_PhysicsDirectBodyState>`, :ref:`PhysicsDirectSpaceState<class_PhysicsDirectSpaceState>`, :ref:`PhysicsServer<class_PhysicsServer>`, :ref:`ProjectSettings<class_ProjectSettings>`, :ref:`Reference<class_Reference>`, :ref:`ResourceLoader<class_ResourceLoader>`, :ref:`ResourceSaver<class_ResourceSaver>`, :ref:`TranslationServer<class_TranslationServer>`, :ref:`TreeItem<class_TreeItem>`, :ref:`UndoRedo<class_UndoRedo>`, :ref:`VisualScriptEditor<class_VisualScriptEditor>`, :ref:`VisualServer<class_VisualServer>`
**Category:** Core

8
classes/class_projectsettings.rst
View File

@@ -28,6 +28,8 @@ Properties
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`application/boot_splash/image<class_ProjectSettings_property_application/boot_splash/image>` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`application/boot_splash/use_filter<class_ProjectSettings_property_application/boot_splash/use_filter>` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`application/config/custom_user_dir_name<class_ProjectSettings_property_application/config/custom_user_dir_name>` |
+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`application/config/icon<class_ProjectSettings_property_application/config/icon>` |
@@ -618,6 +620,12 @@ If ``true``, scale the boot splash image to the full window length when engine s
Path to an image used as the boot splash.
.. _class_ProjectSettings_property_application/boot_splash/use_filter:
- :ref:`bool<class_bool>` **application/boot_splash/use_filter**
If ``true``, applies linear filtering when scaling the image (recommended for high resolution artwork). If ``false``, uses nearest-neighbor interpolation (recommended for pixel art).
.. _class_ProjectSettings_property_application/config/custom_user_dir_name:
- :ref:`String<class_String>` **application/config/custom_user_dir_name**

2
classes/class_reference.rst
View File

@@ -9,7 +9,7 @@ Reference
**Inherits:** :ref:`Object<class_Object>`
**Inherited By:** :ref:`ARVRInterface<class_ARVRInterface>`, :ref:`AStar<class_AStar>`, :ref:`AnimationTrackEditPlugin<class_AnimationTrackEditPlugin>`, :ref:`AudioEffectInstance<class_AudioEffectInstance>`, :ref:`AudioStreamPlayback<class_AudioStreamPlayback>`, :ref:`ConfigFile<class_ConfigFile>`, :ref:`Directory<class_Directory>`, :ref:`EditorExportPlugin<class_EditorExportPlugin>`, :ref:`EditorFeatureProfile<class_EditorFeatureProfile>`, :ref:`EditorImportPlugin<class_EditorImportPlugin>`, :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>`, :ref:`EditorResourceConversionPlugin<class_EditorResourceConversionPlugin>`, :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>`, :ref:`EditorSceneImporter<class_EditorSceneImporter>`, :ref:`EditorScenePostImport<class_EditorScenePostImport>`, :ref:`EditorScript<class_EditorScript>`, :ref:`EncodedObjectAsID<class_EncodedObjectAsID>`, :ref:`Expression<class_Expression>`, :ref:`File<class_File>`, :ref:`FuncRef<class_FuncRef>`, :ref:`GDNative<class_GDNative>`, :ref:`GDScriptFunctionState<class_GDScriptFunctionState>`, :ref:`GDScriptNativeClass<class_GDScriptNativeClass>`, :ref:`HTTPClient<class_HTTPClient>`, :ref:`JSONParseResult<class_JSONParseResult>`, :ref:`KinematicCollision<class_KinematicCollision>`, :ref:`KinematicCollision2D<class_KinematicCollision2D>`, :ref:`Marshalls<class_Marshalls>`, :ref:`MeshDataTool<class_MeshDataTool>`, :ref:`MultiplayerAPI<class_MultiplayerAPI>`, :ref:`Mutex<class_Mutex>`, :ref:`PCKPacker<class_PCKPacker>`, :ref:`PackedDataContainerRef<class_PackedDataContainerRef>`, :ref:`PacketPeer<class_PacketPeer>`, :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>`, :ref:`Physics2DShapeQueryResult<class_Physics2DShapeQueryResult>`, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>`, :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>`, :ref:`PhysicsShapeQueryResult<class_PhysicsShapeQueryResult>`, :ref:`RandomNumberGenerator<class_RandomNumberGenerator>`, :ref:`RegEx<class_RegEx>`, :ref:`RegExMatch<class_RegExMatch>`, :ref:`Resource<class_Resource>`, :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`, :ref:`ResourceFormatSaver<class_ResourceFormatSaver>`, :ref:`ResourceImporter<class_ResourceImporter>`, :ref:`ResourceInteractiveLoader<class_ResourceInteractiveLoader>`, :ref:`SceneState<class_SceneState>`, :ref:`SceneTreeTimer<class_SceneTreeTimer>`, :ref:`Semaphore<class_Semaphore>`, :ref:`SpatialGizmo<class_SpatialGizmo>`, :ref:`SpatialVelocityTracker<class_SpatialVelocityTracker>`, :ref:`StreamPeer<class_StreamPeer>`, :ref:`SurfaceTool<class_SurfaceTool>`, :ref:`TCP_Server<class_TCP_Server>`, :ref:`Thread<class_Thread>`, :ref:`TriangleMesh<class_TriangleMesh>`, :ref:`UPNP<class_UPNP>`, :ref:`UPNPDevice<class_UPNPDevice>`, :ref:`VisualScriptFunctionState<class_VisualScriptFunctionState>`, :ref:`WeakRef<class_WeakRef>`, :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>`, :ref:`XMLParser<class_XMLParser>`
**Inherited By:** :ref:`ARVRInterface<class_ARVRInterface>`, :ref:`AStar<class_AStar>`, :ref:`AnimationTrackEditPlugin<class_AnimationTrackEditPlugin>`, :ref:`AudioEffectInstance<class_AudioEffectInstance>`, :ref:`AudioStreamPlayback<class_AudioStreamPlayback>`, :ref:`CameraFeed<class_CameraFeed>`, :ref:`ConfigFile<class_ConfigFile>`, :ref:`Directory<class_Directory>`, :ref:`EditorExportPlugin<class_EditorExportPlugin>`, :ref:`EditorFeatureProfile<class_EditorFeatureProfile>`, :ref:`EditorImportPlugin<class_EditorImportPlugin>`, :ref:`EditorInspectorPlugin<class_EditorInspectorPlugin>`, :ref:`EditorResourceConversionPlugin<class_EditorResourceConversionPlugin>`, :ref:`EditorResourcePreviewGenerator<class_EditorResourcePreviewGenerator>`, :ref:`EditorSceneImporter<class_EditorSceneImporter>`, :ref:`EditorScenePostImport<class_EditorScenePostImport>`, :ref:`EditorScript<class_EditorScript>`, :ref:`EncodedObjectAsID<class_EncodedObjectAsID>`, :ref:`Expression<class_Expression>`, :ref:`File<class_File>`, :ref:`FuncRef<class_FuncRef>`, :ref:`GDNative<class_GDNative>`, :ref:`GDScriptFunctionState<class_GDScriptFunctionState>`, :ref:`GDScriptNativeClass<class_GDScriptNativeClass>`, :ref:`HTTPClient<class_HTTPClient>`, :ref:`JSONParseResult<class_JSONParseResult>`, :ref:`KinematicCollision<class_KinematicCollision>`, :ref:`KinematicCollision2D<class_KinematicCollision2D>`, :ref:`Marshalls<class_Marshalls>`, :ref:`MeshDataTool<class_MeshDataTool>`, :ref:`MultiplayerAPI<class_MultiplayerAPI>`, :ref:`Mutex<class_Mutex>`, :ref:`PCKPacker<class_PCKPacker>`, :ref:`PackedDataContainerRef<class_PackedDataContainerRef>`, :ref:`PacketPeer<class_PacketPeer>`, :ref:`Physics2DShapeQueryParameters<class_Physics2DShapeQueryParameters>`, :ref:`Physics2DShapeQueryResult<class_Physics2DShapeQueryResult>`, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>`, :ref:`PhysicsShapeQueryParameters<class_PhysicsShapeQueryParameters>`, :ref:`PhysicsShapeQueryResult<class_PhysicsShapeQueryResult>`, :ref:`RandomNumberGenerator<class_RandomNumberGenerator>`, :ref:`RegEx<class_RegEx>`, :ref:`RegExMatch<class_RegExMatch>`, :ref:`Resource<class_Resource>`, :ref:`ResourceFormatLoader<class_ResourceFormatLoader>`, :ref:`ResourceFormatSaver<class_ResourceFormatSaver>`, :ref:`ResourceImporter<class_ResourceImporter>`, :ref:`ResourceInteractiveLoader<class_ResourceInteractiveLoader>`, :ref:`SceneState<class_SceneState>`, :ref:`SceneTreeTimer<class_SceneTreeTimer>`, :ref:`Semaphore<class_Semaphore>`, :ref:`SpatialGizmo<class_SpatialGizmo>`, :ref:`SpatialVelocityTracker<class_SpatialVelocityTracker>`, :ref:`StreamPeer<class_StreamPeer>`, :ref:`SurfaceTool<class_SurfaceTool>`, :ref:`TCP_Server<class_TCP_Server>`, :ref:`Thread<class_Thread>`, :ref:`TriangleMesh<class_TriangleMesh>`, :ref:`UPNP<class_UPNP>`, :ref:`UPNPDevice<class_UPNPDevice>`, :ref:`VisualScriptFunctionState<class_VisualScriptFunctionState>`, :ref:`WeakRef<class_WeakRef>`, :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>`, :ref:`XMLParser<class_XMLParser>`
**Category:** Core

2
classes/class_texture.rst
View File

@@ -9,7 +9,7 @@ Texture
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`AnimatedTexture<class_AnimatedTexture>`, :ref:`AtlasTexture<class_AtlasTexture>`, :ref:`CurveTexture<class_CurveTexture>`, :ref:`GradientTexture<class_GradientTexture>`, :ref:`ImageTexture<class_ImageTexture>`, :ref:`LargeTexture<class_LargeTexture>`, :ref:`MeshTexture<class_MeshTexture>`, :ref:`NoiseTexture<class_NoiseTexture>`, :ref:`ProxyTexture<class_ProxyTexture>`, :ref:`StreamTexture<class_StreamTexture>`, :ref:`ViewportTexture<class_ViewportTexture>`
**Inherited By:** :ref:`AnimatedTexture<class_AnimatedTexture>`, :ref:`AtlasTexture<class_AtlasTexture>`, :ref:`CameraTexture<class_CameraTexture>`, :ref:`CurveTexture<class_CurveTexture>`, :ref:`GradientTexture<class_GradientTexture>`, :ref:`ImageTexture<class_ImageTexture>`, :ref:`LargeTexture<class_LargeTexture>`, :ref:`MeshTexture<class_MeshTexture>`, :ref:`NoiseTexture<class_NoiseTexture>`, :ref:`ProxyTexture<class_ProxyTexture>`, :ref:`StreamTexture<class_StreamTexture>`, :ref:`ViewportTexture<class_ViewportTexture>`
**Category:** Core

16
classes/class_visualserver.rst
View File

@@ -596,7 +596,7 @@ Methods
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`scenario_set_reflection_atlas_size<class_VisualServer_method_scenario_set_reflection_atlas_size>` **(** :ref:`RID<class_RID>` scenario, :ref:`int<class_int>` size, :ref:`int<class_int>` subdiv **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_boot_image<class_VisualServer_method_set_boot_image>` **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale **)** |
| void | :ref:`set_boot_image<class_VisualServer_method_set_boot_image>` **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_debug_generate_wireframes<class_VisualServer_method_set_debug_generate_wireframes>` **(** :ref:`bool<class_bool>` generate **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -638,6 +638,8 @@ Methods
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`texture_allocate<class_VisualServer_method_texture_allocate>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth_3d, :ref:`Format<enum_Image_Format>` format, :ref:`TextureType<enum_VisualServer_TextureType>` type, :ref:`int<class_int>` flags=7 **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`texture_bind<class_VisualServer_method_texture_bind>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` number **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`texture_create<class_VisualServer_method_texture_create>` **(** **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`texture_create_from_image<class_VisualServer_method_texture_create_from_image>` **(** :ref:`Image<class_Image>` image, :ref:`int<class_int>` flags=7 **)** |
@@ -1645,7 +1647,7 @@ enum **EnvironmentBG**:
- **ENV_BG_KEEP** = **5**
- **ENV_BG_MAX** = **6**
- **ENV_BG_MAX** = **7**
.. _enum_VisualServer_EnvironmentDOFBlurQuality:
@@ -3158,9 +3160,9 @@ The callback method must use only 1 argument which will be called with 'userdata
.. _class_VisualServer_method_set_boot_image:
- void **set_boot_image** **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale **)**
- void **set_boot_image** **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)**
Sets a boot image. The color defines the background color and if scale is ``true`` the image will be scaled to fit the screen size.
Sets a boot image. The color defines the background color. If ``scale`` is ``true``, the image will be scaled to fit the screen size. If ``use_filter`` is ``true``, the image will be scaled with linear interpolation. If ``use_filter`` is ``false``, the image will be scaled with nearest-neighbor interpolation.
.. _class_VisualServer_method_set_debug_generate_wireframes:
@@ -3258,6 +3260,12 @@ Sets a sky's texture.
- void **texture_allocate** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth_3d, :ref:`Format<enum_Image_Format>` format, :ref:`TextureType<enum_VisualServer_TextureType>` type, :ref:`int<class_int>` flags=7 **)**
.. _class_VisualServer_method_texture_bind:
- void **texture_bind** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` number **)**
Binds the texture to a texture slot.
.. _class_VisualServer_method_texture_create:
- :ref:`RID<class_RID>` **texture_create** **(** **)**