Преглед изворни кода

Merge pull request #2329 from exeldro/docs

docs/sphinx: Add obs_group_from_source and obs_enum_scenes
Jim пре 6 година
родитељ
комит
500111e230
2 измењених фајлова са 20 додато и 0 уклоњено
  1. 13 0
      docs/sphinx/reference-core.rst
  2. 7 0
      docs/sphinx/reference-scenes.rst

+ 13 - 0
docs/sphinx/reference-core.rst

@@ -228,6 +228,19 @@ Libobs Objects
 
 ---------------------
 
+.. function:: void obs_enum_scenes(bool (*enum_proc)(void*, obs_source_t*), void *param)
+
+   Enumerates all scenes.
+  
+   Callback function returns true to continue enumeration, or false to end
+   enumeration.
+  
+   Use :c:func:`obs_source_get_ref()` or
+   :c:func:`obs_source_get_weak_source()` if you want to retain a
+   reference after obs_enum_scenes finishes.
+ 
+---------------------
+
 .. function:: void obs_enum_outputs(bool (*enum_proc)(void*, obs_output_t*), void *param)
 
    Enumerates outputs.

+ 7 - 0
docs/sphinx/reference-scenes.rst

@@ -494,6 +494,13 @@ Scene Item Group Functions
 
 ---------------------
 
+.. function:: obs_scene_t *obs_group_from_source(const obs_source_t *source)
+
+   :return: The group context, or *NULL* if not a group.  Does not
+            increase the reference
+
+---------------------
+
 .. function:: bool obs_sceneitem_is_group(obs_sceneitem_t *item)
 
    :param item: Scene item