diff --git a/classes/class_cameraattributes.rst b/classes/class_cameraattributes.rst index d79914732cc..371f5445fa2 100644 --- a/classes/class_cameraattributes.rst +++ b/classes/class_cameraattributes.rst @@ -71,6 +71,8 @@ Property Descriptions If ``true``, enables the tonemapping auto exposure mode of the scene renderer. If ``true``, the renderer will automatically determine the exposure setting to adapt to the scene's illumination and the observed light. +\ **Note:** Auto-exposure is only supported in the Forward+ rendering method, not Mobile or Compatibility. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_cameraattributesphysical.rst b/classes/class_cameraattributesphysical.rst index 529fd930152..caf1272a65b 100644 --- a/classes/class_cameraattributesphysical.rst +++ b/classes/class_cameraattributesphysical.rst @@ -27,6 +27,8 @@ The default settings are intended for use in an outdoor environment, tips for se \ **Note:** Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility. +\ **Note:** Auto-exposure is only supported in the Forward+ rendering method, not Mobile or Compatibility. + .. rst-class:: classref-introduction-group Tutorials diff --git a/classes/class_cameraattributespractical.rst b/classes/class_cameraattributespractical.rst index 73d0d636ca5..bde8a03a30a 100644 --- a/classes/class_cameraattributespractical.rst +++ b/classes/class_cameraattributespractical.rst @@ -23,6 +23,10 @@ Controls camera-specific attributes such as auto-exposure, depth of field, and e When used in a :ref:`WorldEnvironment` it provides default settings for exposure, auto-exposure, and depth of field that will be used by all cameras without their own :ref:`CameraAttributes`, including the editor camera. When used in a :ref:`Camera3D` it will override any :ref:`CameraAttributes` set in the :ref:`WorldEnvironment`. When used in :ref:`VoxelGI` or :ref:`LightmapGI`, only the exposure settings will be used. +\ **Note:** Depth of field blur is only supported in the Forward+ and Mobile rendering methods, not Compatibility. + +\ **Note:** Auto-exposure is only supported in the Forward+ rendering method, not Mobile or Compatibility. + .. rst-class:: classref-reftable-group Properties diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index 70c5e7f8a7d..f65fa80b7a4 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -489,6 +489,15 @@ Finds and returns the first key whose associated value is equal to ``value``, or Returns the corresponding value for the given ``key`` in the dictionary. If the ``key`` does not exist, returns ``default``, or ``null`` if the parameter is omitted. +\ **Note:** If the ``default`` argument is computationally expensive or has unwanted side effects, consider using the :ref:`has()` method instead: + +:: + + # Always calls `expensive_function()`. + dict.get("key", expensive_function()) + # Calls `expensive_function()` only if the key does not exist. + dict.get("key") if dict.has("key") else expensive_function() + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 27e59d8eb39..b79a2abe3f1 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -356,7 +356,7 @@ Every :ref:`Dictionary` contains a ``name`` identifier, and a Returns a :ref:`Dictionary` of categorized donor names. Each entry is an :ref:`Array` of strings: -{``donors``} +\ ``donors`` .. rst-class:: classref-item-separator diff --git a/classes/class_foldablecontainer.rst b/classes/class_foldablecontainer.rst index cb4cd345bec..e25b46448a9 100644 --- a/classes/class_foldablecontainer.rst +++ b/classes/class_foldablecontainer.rst @@ -211,7 +211,7 @@ The :ref:`FoldableGroup` associated with the container. Whe - |void| **set_folded**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_folded**\ (\ ) -If ``true``, the container will becomes folded and will hide all its children. +If ``true``, the container will become folded and will hide all its children. .. rst-class:: classref-item-separator diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 0419f7296c0..e7b098c4fe6 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -619,7 +619,20 @@ Generates a baked mesh that represents all meshes in the assigned :ref:`MeshLibr :ref:`Vector3` **map_to_local**\ (\ map_position\: :ref:`Vector3i`\ ) |const| :ref:`🔗` -Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use :ref:`Node3D.to_global()`. See also :ref:`local_to_map()`. +Returns the position of a grid cell in the GridMap's local coordinate space. The returned position, for each axis, is either cell center or the cell edge closer to negative infinity, based on the values of :ref:`cell_center_x`, :ref:`cell_center_y`, :ref:`cell_center_z`. To convert the returned value into global coordinates, use :ref:`Node3D.to_global()`. See also :ref:`local_to_map()`. + +:: + + # All examples for: cell_size = Vector3(2.0, 3.0, 4.0) + + # cell_center_x = true, cell_center_y = true, cell_center_z = true + map_to_local(Vector3i(0, 0, 0)) # Returns Vector3(1.0, 1.5, 2.0) + + # cell_center_x = false, cell_center_y = false, cell_center_z = false + map_to_local(Vector3i(0, 0, 0)) # Returns Vector3(0.0, 0.0, 0.0) + + # cell_center_x = true, cell_center_y = false, cell_center_z = true + map_to_local(Vector3i(0, 0, 0)) # Returns Vector3(1.0, 0.0, 2.0) .. rst-class:: classref-item-separator diff --git a/classes/class_node.rst b/classes/class_node.rst index 80a09533798..edd60973905 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -1949,7 +1949,7 @@ If ``owned`` is ``true``, only descendants with a valid :ref:`owner` if no match is found. The matching is done against node names, *not* their paths, through :ref:`String.match()`. As such, it is case-sensitive, ``"*"`` matches zero or more characters, and ``"?"`` matches any single character. -If ``type`` is not empty, only ancestors inheriting from ``type`` are included (see :ref:`Object.is_class()`). +If ``type`` is not empty, only descendants inheriting from ``type`` are included (see :ref:`Object.is_class()`). If ``recursive`` is ``false``, only this node's direct children are checked. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. Internal children are also included in the search (see ``internal`` parameter in :ref:`add_child()`). diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index b6f7a105882..7ac7db05b46 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`ImageFramesFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`Logger`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`ScriptBacktrace`, :ref:`Semaphore`, :ref:`SignalSmith`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorContextMenuPlugin`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorExportPreset`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`GLTFObjectModelProperty`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`ImageFramesFormatLoader`, :ref:`JavaClass`, :ref:`JavaObject`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`Logger`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`OpenXRFutureResult`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`ScriptBacktrace`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`SoundSmith`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TranslationDomain`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 2a3bbbf211c..d67ddc6d9e3 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -249,7 +249,7 @@ The unique path to this resource. If it has been saved to disk, the value will b - |void| **set_scene_unique_id**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_scene_unique_id**\ (\ ) -A unique identifier relative to the this resource's scene. If left empty, the ID is automatically generated when this resource is saved inside a :ref:`PackedScene`. If the resource is not inside a scene, this property is empty by default. +A unique identifier relative to this resource's scene. If left empty, the ID is automatically generated when this resource is saved inside a :ref:`PackedScene`. If the resource is not inside a scene, this property is empty by default. \ **Note:** When the :ref:`PackedScene` is saved, if multiple resources in the same scene use the same ID, only the earliest resource in the scene hierarchy keeps the original ID. The other resources are assigned new IDs from :ref:`generate_scene_unique_id()`. diff --git a/classes/class_signalsmith.rst b/classes/class_soundsmith.rst similarity index 70% rename from classes/class_signalsmith.rst rename to classes/class_soundsmith.rst index 5e2b4c82541..8015f82a363 100644 --- a/classes/class_signalsmith.rst +++ b/classes/class_soundsmith.rst @@ -3,23 +3,23 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Redot engine sources. .. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/SignalSmith.xml. +.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/SoundSmith.xml. -.. _class_SignalSmith: +.. _class_SoundSmith: -SignalSmith -=========== +SoundSmith +========== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -Performs time-stretching and pitch-shifting on raw audio buffers using Signalsmith. +Performs time-stretching and pitch-shifting on raw audio buffers using Soundsmith. .. rst-class:: classref-introduction-group Description ----------- -SignalSmith is a low-level audio processing utility which wraps the Signalsmith time-stretching library. It operates on raw interleaved floating-point PCM audio buffers and allows independent control of playback tempo and pitch. +SoundSmith is a low-level audio processing utility which wraps the Soundsmith time-stretching library. It operates on raw interleaved floating-point PCM audio buffers and allows independent control of playback tempo and pitch. .. rst-class:: classref-reftable-group @@ -29,25 +29,25 @@ Methods .. table:: :widths: auto - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`AudioStreamWAV` | :ref:`change_tempo`\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_channels`\ (\ ) |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`get_last_sample_rate`\ (\ ) |const| | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`PackedFloat32Array` | :ref:`process`\ (\ input\: :ref:`PackedFloat32Array`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`reset`\ (\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_channels`\ (\ channels\: :ref:`int`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_pitch`\ (\ pitch\: :ref:`float`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_sample_rate`\ (\ rate\: :ref:`int`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |void| | :ref:`set_tempo`\ (\ tempo\: :ref:`float`\ ) | - +-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`AudioStreamWAV` | :ref:`change_tempo`\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_channels`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`get_last_sample_rate`\ (\ ) |const| | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedFloat32Array` | :ref:`process`\ (\ input\: :ref:`PackedFloat32Array`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`reset`\ (\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_channels`\ (\ channels\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_pitch`\ (\ pitch\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_sample_rate`\ (\ rate\: :ref:`int`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`set_tempo`\ (\ tempo\: :ref:`float`\ ) | + +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -58,13 +58,13 @@ Methods Method Descriptions ------------------- -.. _class_SignalSmith_method_change_tempo: +.. _class_SoundSmith_method_change_tempo: .. rst-class:: classref-method -:ref:`AudioStreamWAV` **change_tempo**\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) :ref:`🔗` +:ref:`AudioStreamWAV` **change_tempo**\ (\ path\: :ref:`String`, tempo\: :ref:`float`, pitch\: :ref:`float` = 1.0\ ) :ref:`🔗` -Loads an MP3 file, applies time-stretching and pitch-shifting using the Signalsmith engine, and returns a streamable AudioStreamWAV. +Loads an MP3 file, applies time-stretching and pitch-shifting using the Soundsmith engine, and returns a streamable AudioStreamWAV. The `tempo` parameter controls playback speed without affecting pitch. A value of `1.0` preserves the original speed. @@ -76,11 +76,11 @@ and `0.5` lowers pitch by one octave. ---- -.. _class_SignalSmith_method_get_last_channels: +.. _class_SoundSmith_method_get_last_channels: .. rst-class:: classref-method -:ref:`int` **get_last_channels**\ (\ ) |const| :ref:`🔗` +:ref:`int` **get_last_channels**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -90,11 +90,11 @@ and `0.5` lowers pitch by one octave. ---- -.. _class_SignalSmith_method_get_last_sample_rate: +.. _class_SoundSmith_method_get_last_sample_rate: .. rst-class:: classref-method -:ref:`int` **get_last_sample_rate**\ (\ ) |const| :ref:`🔗` +:ref:`int` **get_last_sample_rate**\ (\ ) |const| :ref:`🔗` .. container:: contribute @@ -104,11 +104,11 @@ and `0.5` lowers pitch by one octave. ---- -.. _class_SignalSmith_method_process: +.. _class_SoundSmith_method_process: .. rst-class:: classref-method -:ref:`PackedFloat32Array` **process**\ (\ input\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` +:ref:`PackedFloat32Array` **process**\ (\ input\: :ref:`PackedFloat32Array`\ ) :ref:`🔗` Processes a block of interleaved audio samples and returns a new buffer containing the time-stretched and pitch-shifted result. @@ -118,11 +118,11 @@ The effective playback speed is determined by the ratio of input samples to outp ---- -.. _class_SignalSmith_method_reset: +.. _class_SoundSmith_method_reset: .. rst-class:: classref-method -|void| **reset**\ (\ ) :ref:`🔗` +|void| **reset**\ (\ ) :ref:`🔗` Resets the internal processing state. @@ -132,11 +132,11 @@ This should be called when restarting playback or discontinuously changing input ---- -.. _class_SignalSmith_method_set_channels: +.. _class_SoundSmith_method_set_channels: .. rst-class:: classref-method -|void| **set_channels**\ (\ channels\: :ref:`int`\ ) :ref:`🔗` +|void| **set_channels**\ (\ channels\: :ref:`int`\ ) :ref:`🔗` Sets the number of audio channels. @@ -146,11 +146,11 @@ Input and output buffers are expected to be interleaved according to this channe ---- -.. _class_SignalSmith_method_set_pitch: +.. _class_SoundSmith_method_set_pitch: .. rst-class:: classref-method -|void| **set_pitch**\ (\ pitch\: :ref:`float`\ ) :ref:`🔗` +|void| **set_pitch**\ (\ pitch\: :ref:`float`\ ) :ref:`🔗` Sets the pitch transpose factor. @@ -160,11 +160,11 @@ A value of `1.0` leaves pitch unchanged. Values greater than `1.0` raise pitch, ---- -.. _class_SignalSmith_method_set_sample_rate: +.. _class_SoundSmith_method_set_sample_rate: .. rst-class:: classref-method -|void| **set_sample_rate**\ (\ rate\: :ref:`int`\ ) :ref:`🔗` +|void| **set_sample_rate**\ (\ rate\: :ref:`int`\ ) :ref:`🔗` Sets the sample rate, in Hz, used by the internal processing engine. @@ -174,11 +174,11 @@ Changing the sample rate resets the internal state. ---- -.. _class_SignalSmith_method_set_tempo: +.. _class_SoundSmith_method_set_tempo: .. rst-class:: classref-method -|void| **set_tempo**\ (\ tempo\: :ref:`float`\ ) :ref:`🔗` +|void| **set_tempo**\ (\ tempo\: :ref:`float`\ ) :ref:`🔗` Sets the tempo multiplier used during processing. diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 702fbebc589..caeb28c73f5 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -711,6 +711,8 @@ If ``true``, column titles are visible. The number of columns. +Prints an error and does not allow setting the columns during mouse selection. + .. rst-class:: classref-item-separator ---- @@ -849,6 +851,8 @@ Method Descriptions Clears the tree. This removes all items. +Prints an error and does not allow clearing the tree if called during mouse selection. + .. rst-class:: classref-item-separator ---- @@ -865,6 +869,8 @@ If ``parent`` is ``null``, the root item will be the parent, or the new item wil The new item will be the ``index``-th child of parent, or it will be the last child if there are not enough siblings. +Prints an error and returns ``null`` if called during mouse selection, or if the ``parent`` does not belong to this tree. + .. rst-class:: classref-item-separator ---- diff --git a/classes/index.rst b/classes/index.rst index 4eba42a0b5a..2b99d8dfe72 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -969,8 +969,8 @@ Other objects class_scriptlanguageextension class_semaphore class_shaderincludedb - class_signalsmith class_skinreference + class_soundsmith class_streampeer class_streampeerbuffer class_streampeerextension