From 74a1aeb59362f05a35d29dfef78ce2c6779c9422 Mon Sep 17 00:00:00 2001 From: tt2468 Date: Thu, 18 Nov 2021 23:49:24 -0800 Subject: [PATCH] docs: Minor function description tweaks (reference-scenes) - 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()` --- docs/sphinx/reference-scenes.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sphinx/reference-scenes.rst b/docs/sphinx/reference-scenes.rst index ca795d954..5b065967d 100644 --- a/docs/sphinx/reference-scenes.rst +++ b/docs/sphinx/reference-scenes.rst @@ -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 ---------------------