opensource/obs-studio
3
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2026-09-24 23:31:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs,libobs: Remove deprecated scene item transition functions

Browse Source 
Deprecated in 28.0, documentation erroneously states 27.2.

The following functions were erroneously not marked as deprecated in
the header:
- obs_sceneitem_set_show_transition()
- obs_sceneitem_set_show_transition_duration()
This commit is contained in:
derrod
2024-08-28 19:10:27 -04:00
committed by Ryan Foster
parent 75cde08e8d
commit 8729cebce7
3 changed files with 0 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sphinx/reference-scenes.rst
-38
View File
@@ -615,16 +615,6 @@ Scene Item Functions
---------------------
.. function:: void obs_sceneitem_set_show_transition(obs_sceneitem_t *item, obs_source_t *transition)
void obs_sceneitem_set_hide_transition(obs_sceneitem_t *item, obs_source_t *transition)
Sets a transition for showing or hiding a scene item. Set *NULL* to remove the transition.
.. deprecated:: 27.2.4
Use :c:func:`obs_sceneitem_set_transition()` instead.
---------------------
.. function:: obs_source_t *obs_sceneitem_get_transition(obs_sceneitem_t *item, bool show)
:param item: The target scene item
@@ -634,14 +624,6 @@ Scene Item Functions
---------------------
.. function:: obs_source_t *obs_sceneitem_get_show_transition(obs_sceneitem_t *item)
obs_source_t *obs_sceneitem_get_hide_transition(obs_sceneitem_t *item)
:return: The transition for showing or hiding a scene item. *NULL* if no transition is set.
.. deprecated:: 27.2.4
Use :c:func:`obs_sceneitem_get_transition()` instead.
---------------------
.. function:: void obs_sceneitem_set_transition_duration(obs_sceneitem_t *item, bool show, uint32_t duration_ms)
@@ -655,16 +637,6 @@ Scene Item Functions
---------------------
.. function:: void obs_sceneitem_set_show_transition_duration(obs_sceneitem_t *item, uint32_t duration_ms)
void obs_sceneitem_set_hide_transition_duration(obs_sceneitem_t *item, uint32_t duration_ms)
Sets the transition duration for showing or hiding a scene item.
.. deprecated:: 27.2.4
Use :c:func:`obs_sceneitem_set_transition_duration()` instead.
---------------------
.. function:: uint32_t obs_sceneitem_get_transition_duration(obs_sceneitem_t *item, bool show)
Gets the transition duration for showing or hiding a scene item.
@@ -676,16 +648,6 @@ Scene Item Functions
---------------------
.. function:: uint32_t obs_sceneitem_get_show_transition_duration(obs_sceneitem_t *item)
uint32_t obs_sceneitem_get_hide_transition_duration(obs_sceneitem_t *item)
:return: The transition duration in ms for showing or hiding a scene item.
.. deprecated:: 27.2.4
Use :c:func:`obs_sceneitem_get_transition_duration()` instead.
---------------------
.. function:: void obs_sceneitem_do_transition(obs_sceneitem_t *item, bool visible)
Start the transition for showing or hiding a scene item.