mirror/obs-studio
0
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2024-09-19 20:32:15 +02:00
Code

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-21 09:34:44 +02:00 committed by Ryan Foster
parent 75cde08e8d
commit 8729cebce7
3 changed files with 0 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/sphinx/reference-scenes.rst
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.

66
libobs/obs-scene.c
View File

@ -4403,72 +4403,6 @@ void obs_sceneitem_force_update_transform(obs_sceneitem_t *item)
update_item_transform(item, false);
}
void obs_sceneitem_set_show_transition(obs_sceneitem_t *item,
obs_source_t *transition)
{
if (!item)
return;
if (item->show_transition)
obs_source_release(item->show_transition);
item->show_transition = obs_source_get_ref(transition);
}
void obs_sceneitem_set_show_transition_duration(obs_sceneitem_t *item,
uint32_t duration_ms)
{
if (!item)
return;
item->show_transition_duration = duration_ms;
}
obs_source_t *obs_sceneitem_get_show_transition(obs_sceneitem_t *item)
{
if (!item)
return NULL;
return item->show_transition;
}
uint32_t obs_sceneitem_get_show_transition_duration(obs_sceneitem_t *item)
{
if (!item)
return 0;
return item->show_transition_duration;
}
void obs_sceneitem_set_hide_transition(obs_sceneitem_t *item,
obs_source_t *transition)
{
if (!item)
return;
if (item->hide_transition)
obs_source_release(item->hide_transition);
item->hide_transition = obs_source_get_ref(transition);
}
void obs_sceneitem_set_hide_transition_duration(obs_sceneitem_t *item,
uint32_t duration_ms)
{
if (!item)
return;
item->hide_transition_duration = duration_ms;
}
obs_source_t *obs_sceneitem_get_hide_transition(obs_sceneitem_t *item)
{
if (!item)
return NULL;
return item->hide_transition;
}
uint32_t obs_sceneitem_get_hide_transition_duration(obs_sceneitem_t *item)
{
if (!item)
return 0;
return item->hide_transition_duration;
}
void obs_sceneitem_set_transition(obs_sceneitem_t *item, bool show,
obs_source_t *transition)
{

19
libobs/obs.h
View File

@ -1997,25 +1997,6 @@ obs_group_or_scene_from_source(const obs_source_t *source)
EXPORT void obs_sceneitem_defer_group_resize_begin(obs_sceneitem_t *item);
EXPORT void obs_sceneitem_defer_group_resize_end(obs_sceneitem_t *item);
EXPORT void obs_sceneitem_set_show_transition(obs_sceneitem_t *item,
obs_source_t *transition);
EXPORT void obs_sceneitem_set_show_transition_duration(obs_sceneitem_t *item,
uint32_t duration_ms);
OBS_DEPRECATED EXPORT obs_source_t *
obs_sceneitem_get_show_transition(obs_sceneitem_t *item);
OBS_DEPRECATED EXPORT uint32_t
obs_sceneitem_get_show_transition_duration(obs_sceneitem_t *item);
OBS_DEPRECATED EXPORT void
obs_sceneitem_set_hide_transition(obs_sceneitem_t *item,
obs_source_t *transition);
OBS_DEPRECATED EXPORT void
obs_sceneitem_set_hide_transition_duration(obs_sceneitem_t *item,
uint32_t duration_ms);
OBS_DEPRECATED EXPORT obs_source_t *
obs_sceneitem_get_hide_transition(obs_sceneitem_t *item);
OBS_DEPRECATED EXPORT uint32_t
obs_sceneitem_get_hide_transition_duration(obs_sceneitem_t *item);
EXPORT void obs_sceneitem_set_transition(obs_sceneitem_t *item, bool show,
obs_source_t *transition);
EXPORT obs_source_t *obs_sceneitem_get_transition(obs_sceneitem_t *item,