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

docs: Minor function description tweaks (reference-scenes)

Browse Source 
- Changes the note under obs_sceneitem_get_id(). Getting the id of a
sceneitem is not dangerous and does not cause errors. Only
obs_sceneitem_set_id() can cause errors.
- Changes wording on `obs_group_or_scene_from_source()`
This commit is contained in:
tt2468 2021-11-18 23:49:24 -08:00 committed by Jim
parent fee5b67bef
commit 74a1aeb593
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/sphinx/reference-scenes.rst
View File

@ -315,8 +315,7 @@ Scene Item Functions
.. function:: int64_t obs_sceneitem_get_id(const obs_sceneitem_t *item)
This is a dangerous function and should not
normally be used. It can cause errors within obs.
Gets the numeric identifier of the sceneitem.
:return: Gets the unique numeric identifier of the scene item.
@ -615,8 +614,9 @@ Scene Item Group Functions
.. function:: obs_scene_t *obs_group_or_scene_from_source(const obs_source_t *source)
:return: The group or scene context, or *NULL* if neither a
group nor a scene. Does not increase the reference
:return: The context for the source, regardless of if it is a
group or a scene. *NULL* if neither. Does not increase
the reference
---------------------