jp9000
/
obs-studio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/sphinx: Fix documentation for addref/release functions 

Incorrectly implied that both addref and release calls were deprecated;
only addref calls are deprecated.
master
jp9000 2022-01-25 06:21:32 -08:00
parent 0377b962b5
commit c1905f4e53
5 changed files with 39 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/sphinx/reference-encoders.rst
View File

@ -321,10 +321,8 @@ General Encoder Functions
---------------------
.. function:: void obs_encoder_addref(obs_encoder_t *encoder)
void obs_encoder_release(obs_encoder_t *encoder)
Adds/releases a reference to an encoder. When the last reference is
released, the encoder is destroyed.
Adds a reference to an encoder.
.. deprecated:: 27.2.0
Use :c:func:`obs_encoder_get_ref()` instead.
@ -338,6 +336,13 @@ General Encoder Functions
---------------------
.. function:: void obs_encoder_release(obs_encoder_t *encoder)
Releases a reference to an encoder. When the last reference is released,
the encoder is destroyed.
---------------------
.. function:: obs_weak_encoder_t *obs_encoder_get_weak_encoder(obs_encoder_t *encoder)
obs_encoder_t *obs_weak_encoder_get_encoder(obs_weak_encoder_t *weak)

11
docs/sphinx/reference-outputs.rst
View File

@ -334,10 +334,8 @@ General Output Functions
---------------------
.. function:: void obs_output_addref(obs_output_t *output)
void obs_output_release(obs_output_t *output)
Adds/releases a reference to an output. When the last reference is
released, the output is destroyed.
Adds a reference to an output.
.. deprecated:: 27.2.0
Use :c:func:`obs_output_get_ref()` instead.
@ -351,6 +349,13 @@ General Output Functions
---------------------
.. function:: void obs_output_release(obs_output_t *output)
Releases a reference to an output. When the last reference is
released, the output is destroyed.
---------------------
.. function:: obs_weak_output_t *obs_output_get_weak_output(obs_output_t *output)
obs_output_t *obs_weak_output_get_output(obs_weak_output_t *weak)

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

11
docs/sphinx/reference-services.rst
View File

@ -180,10 +180,8 @@ General Service Functions
---------------------
.. function:: void obs_service_addref(obs_service_t *service)
void obs_service_release(obs_service_t *service)
Adds/releases a reference to a service. When the last reference is
released, the service is destroyed.
Adds a reference to a service.
.. deprecated:: 27.2.0
Use :c:func:`obs_service_get_ref()` instead.
@ -197,6 +195,13 @@ General Service Functions
---------------------
.. function:: void obs_service_release(obs_service_t *service)
Releases a reference to a service. When the last reference is
released, the service is destroyed.
---------------------
.. function:: obs_weak_service_t *obs_service_get_weak_service(obs_service_t *service)
obs_service_t *obs_weak_service_get_service(obs_weak_service_t *weak)

11
docs/sphinx/reference-sources.rst
View File

@ -732,10 +732,8 @@ General Source Functions
---------------------
.. function:: void obs_source_addref(obs_source_t *source)
void obs_source_release(obs_source_t *source)
Adds/releases a reference to a source. When the last reference is
released, the source is destroyed.
Adds a reference to a source.
.. deprecated:: 27.2.0
Use :c:func:`obs_source_get_ref()` instead.
@ -749,6 +747,13 @@ General Source Functions
---------------------
.. function:: void obs_source_release(obs_source_t *source)
Releases a reference to a source. When the last reference is
released, the source is destroyed.
---------------------
.. function:: obs_weak_source_t *obs_source_get_weak_source(obs_source_t *source)
obs_source_t *obs_weak_source_get_source(obs_weak_source_t *weak)