starred/obs-studio
1
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2026-09-27 17:55:42 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs/sphinx: Fix documentation for addref/release functions

Browse Source 
Incorrectly implied that both addref and release calls were deprecated;
only addref calls are deprecated.
This commit is contained in:
jp9000
2022-01-25 06:22:13 -08:00
parent 0377b962b5
commit c1905f4e53
5 changed files with 39 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sphinx/reference-scenes.rst
+7 -2
View File
@@ -197,9 +197,8 @@ General Scene Functions
---------------------
.. function:: void obs_scene_addref(obs_scene_t *scene)
void obs_scene_release(obs_scene_t *scene)
Adds/releases a reference to a scene.
Adds a reference to a scene.
.. deprecated:: 27.2.0
Use :c:func:`obs_scene_get_ref()` instead.
@@ -213,6 +212,12 @@ General Scene Functions
---------------------
.. function:: void obs_scene_release(obs_scene_t *scene)
Releases a reference to a scene.
---------------------
.. function:: obs_sceneitem_t *obs_scene_add(obs_scene_t *scene, obs_source_t *source)
:return: A new scene item for a source within a scene. Does not