Skip to content

Commit 7967718

Browse files
authored
Merge pull request #11192 from godotengine/classref/sync-a3b42d8
classref: Sync with current master branch (a3b42d8)
2 parents 0f9791e + 85131fb commit 7967718

File tree

8 files changed

+93
-8
lines changed

8 files changed

+93
-8
lines changed

classes/class_cameraserver.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,18 @@ Emitted when a :ref:`CameraFeed<class_CameraFeed>` is added (e.g. a webcam is pl
8686

8787
Emitted when a :ref:`CameraFeed<class_CameraFeed>` is removed (e.g. a webcam is unplugged).
8888

89+
.. rst-class:: classref-item-separator
90+
91+
----
92+
93+
.. _class_CameraServer_signal_camera_feeds_updated:
94+
95+
.. rst-class:: classref-signal
96+
97+
**camera_feeds_updated**\ (\ ) :ref:`🔗<class_CameraServer_signal_camera_feeds_updated>`
98+
99+
Emitted when camera feeds are updated.
100+
89101
.. rst-class:: classref-section-separator
90102

91103
----
@@ -157,6 +169,35 @@ If ``true``, the server is actively monitoring available camera feeds.
157169

158170
This has a performance cost, so only set it to ``true`` when you're actively accessing the camera.
159171

172+
\ **Note:** After setting it to ``true``, you can receive updated camera feeds through the :ref:`camera_feeds_updated<class_CameraServer_signal_camera_feeds_updated>` signal.
173+
174+
175+
.. tabs::
176+
177+
.. code-tab:: gdscript
178+
179+
func _ready():
180+
CameraServer.camera_feeds_updated.connect(_on_camera_feeds_updated)
181+
CameraServer.monitoring_feeds = true
182+
183+
func _on_camera_feeds_updated():
184+
var feeds = CameraServer.feeds()
185+
186+
.. code-tab:: csharp
187+
188+
public override void _Ready()
189+
{
190+
CameraServer.CameraFeedsUpdated += OnCameraFeedsUpdated;
191+
CameraServer.MonitoringFeeds = true;
192+
}
193+
194+
void OnCameraFeedsUpdated()
195+
{
196+
var feeds = CameraServer.Feeds();
197+
}
198+
199+
200+
160201
.. rst-class:: classref-section-separator
161202

162203
----

classes/class_label.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,8 @@ The number of characters to display. If set to ``-1``, all characters are displa
494494

495495
\ **Note:** Setting this property updates :ref:`visible_ratio<class_Label_property_visible_ratio>` accordingly.
496496

497+
\ **Note:** Characters are counted as Unicode codepoints. A single visible grapheme may contain multiple codepoints (e.g. certain emoji use three codepoints). A single codepoint may contain two UTF-16 characters, which are used in C# strings.
498+
497499
.. rst-class:: classref-item-separator
498500

499501
----

classes/class_os.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1481,6 +1481,30 @@ The second element holds the driver version. For example, on the ``nvidia`` driv
14811481

14821482
\ **Note:** This method is only supported on Linux/BSD and Windows when not running in headless mode. On other platforms, it returns an empty array.
14831483

1484+
\ **Note:** This method will run slowly the first time it is called in a session; it can take several seconds depending on the operating system and hardware. It is blocking if called on the main thread, so it's recommended to call it on a separate thread using :ref:`Thread<class_Thread>`. This allows the engine to keep running while the information is being retrieved. However, :ref:`get_video_adapter_driver_info()<class_OS_method_get_video_adapter_driver_info>` is *not* thread-safe, so it should not be called from multiple threads at the same time.
1485+
1486+
1487+
.. tabs::
1488+
1489+
.. code-tab:: gdscript
1490+
1491+
var thread = Thread.new()
1492+
1493+
func _ready():
1494+
thread.start(
1495+
func():
1496+
var driver_info = OS.get_video_adapter_driver_info()
1497+
if not driver_info.is_empty():
1498+
print("Driver: %s %s" % [driver_info[0], driver_info[1]])
1499+
else:
1500+
print("Driver: (unknown)")
1501+
)
1502+
1503+
func _exit_tree():
1504+
thread.wait_to_finish()
1505+
1506+
1507+
14841508
.. rst-class:: classref-item-separator
14851509

14861510
----

classes/class_renderingserver.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8332,7 +8332,11 @@ Tries to free an object in the RenderingServer. To avoid memory leaks, this shou
83328332

83338333
Returns the name of the current rendering driver. This can be ``vulkan``, ``d3d12``, ``metal``, ``opengl3``, ``opengl3_es``, or ``opengl3_angle``. See also :ref:`get_current_rendering_method()<class_RenderingServer_method_get_current_rendering_method>`.
83348334

8335-
The rendering driver is determined by :ref:`ProjectSettings.rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`, the ``--rendering-driver`` command line argument that overrides this project setting, or an automatic fallback that is applied depending on the hardware.
8335+
When :ref:`ProjectSettings.rendering/renderer/rendering_method<class_ProjectSettings_property_rendering/renderer/rendering_method>` is ``forward_plus`` or ``mobile``, the rendering driver is determined by :ref:`ProjectSettings.rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`.
8336+
8337+
When :ref:`ProjectSettings.rendering/renderer/rendering_method<class_ProjectSettings_property_rendering/renderer/rendering_method>` is ``gl_compatibility``, the rendering driver is determined by :ref:`ProjectSettings.rendering/gl_compatibility/driver<class_ProjectSettings_property_rendering/gl_compatibility/driver>`.
8338+
8339+
The rendering driver is also determined by the ``--rendering-driver`` command line argument that overrides this project setting, or an automatic fallback that is applied depending on the hardware.
83368340

83378341
.. rst-class:: classref-item-separator
83388342

@@ -12487,9 +12491,7 @@ Equivalent to :ref:`Viewport.use_debanding<class_Viewport_property_use_debanding
1248712491

1248812492
|void| **viewport_set_use_hdr_2d**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_hdr_2d>`
1248912493

12490-
If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an ``RGBA16`` framebuffer, while when using the Mobile renderer it will be an ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d<class_Viewport_property_use_hdr_2d>`.
12491-
12492-
\ **Note:** This setting will have no effect when using the Compatibility renderer, which always renders in low dynamic range for performance reasons.
12494+
If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ or Compatibility rendering method this will be an ``RGBA16`` framebuffer, while when using the Mobile rendering method it will be an ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d<class_Viewport_property_use_hdr_2d>`.
1249312495

1249412496
.. rst-class:: classref-item-separator
1249512497

classes/class_richtextlabel.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1110,6 +1110,8 @@ The number of characters to display. If set to ``-1``, all characters are displa
11101110

11111111
\ **Note:** Setting this property updates :ref:`visible_ratio<class_RichTextLabel_property_visible_ratio>` accordingly.
11121112

1113+
\ **Note:** Characters are counted as Unicode codepoints. A single visible grapheme may contain multiple codepoints (e.g. certain emoji use three codepoints). A single codepoint may contain two UTF-16 characters, which are used in C# strings.
1114+
11131115
.. rst-class:: classref-item-separator
11141116

11151117
----

classes/class_svgtexture.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Methods
5050
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
5151
| :ref:`SVGTexture<class_SVGTexture>` | :ref:`create_from_string<class_SVGTexture_method_create_from_string>`\ (\ source\: :ref:`String<class_String>`, scale\: :ref:`float<class_float>` = 1.0, saturation\: :ref:`float<class_float>` = 1.0, color_map\: :ref:`Dictionary<class_Dictionary>` = {}\ ) |static| |
5252
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
53+
| :ref:`RID<class_RID>` | :ref:`get_scaled_rid<class_SVGTexture_method_get_scaled_rid>`\ (\ ) |const| |
54+
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
5355
| :ref:`String<class_String>` | :ref:`get_source<class_SVGTexture_method_get_source>`\ (\ ) |const| |
5456
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
5557
| |void| | :ref:`set_size_override<class_SVGTexture_method_set_size_override>`\ (\ size\: :ref:`Vector2i<class_Vector2i>`\ ) |
@@ -134,6 +136,18 @@ Creates a new **SVGTexture** and initializes it by allocating and setting the SV
134136

135137
----
136138

139+
.. _class_SVGTexture_method_get_scaled_rid:
140+
141+
.. rst-class:: classref-method
142+
143+
:ref:`RID<class_RID>` **get_scaled_rid**\ (\ ) |const| :ref:`🔗<class_SVGTexture_method_get_scaled_rid>`
144+
145+
Returns the :ref:`RID<class_RID>` of the texture rasterized to match the oversampling of the currently drawn canvas item.
146+
147+
.. rst-class:: classref-item-separator
148+
149+
----
150+
137151
.. _class_SVGTexture_method_get_source:
138152

139153
.. rst-class:: classref-method

classes/class_tree.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,9 @@ Emitted when an item is double-clicked, or selected with a ``ui_accept`` input e
443443

444444
**item_collapsed**\ (\ item\: :ref:`TreeItem<class_TreeItem>`\ ) :ref:`🔗<class_Tree_signal_item_collapsed>`
445445

446-
Emitted when an item is collapsed by a click on the folding arrow.
446+
Emitted when an item is expanded or collapsed by clicking on the folding arrow or through code.
447+
448+
\ **Note:** Despite its name, this signal is also emitted when an item is expanded.
447449

448450
.. rst-class:: classref-item-separator
449451

classes/class_viewport.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1966,9 +1966,7 @@ See also :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding<cla
19661966
- |void| **set_use_hdr_2d**\ (\ value\: :ref:`bool<class_bool>`\ )
19671967
- :ref:`bool<class_bool>` **is_using_hdr_2d**\ (\ )
19681968

1969-
If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an ``RGBA16`` framebuffer, while when using the Mobile renderer it will be an ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients.
1970-
1971-
\ **Note:** This setting will have no effect when using the Compatibility renderer, which always renders in low dynamic range for performance reasons.
1969+
If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ or Compatibility rendering method this will be an ``RGBA16`` framebuffer, while when using the Mobile rendering method it will be an ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients.
19721970

19731971
.. rst-class:: classref-item-separator
19741972

0 commit comments

Comments
 (0)