lagertonne/yolobs-studio
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

New upstream version 25.0.3+dfsg1

Browse source
This commit is contained in:
Sebastian Ramacher 2020-03-25 09:07:22 +01:00
parent 04fe0efc67
commit 8b2e5f2130
569 changed files with 62491 additions and 5875 deletions
Download patch file Download diff file Expand all files Collapse all files

73
docs/sphinx/reference-scenes.rst
View file

@ -135,6 +135,11 @@ Scene Signals
Called when scene items have been reoredered in the scene.
**refresh** (ptr scene)
Called when the entire scene item list needs to be refreshed.
Usually this is only used when groups have changed.
**item_visible** (ptr scene, ptr item, bool visible)
Called when a scene item's visibility state changes.
@ -225,6 +230,16 @@ General Scene Functions
---------------------
.. function:: obs_sceneitem_t *obs_scene_find_source_recursive(obs_scene_t *scene, const char *name)
Same as obs_scene_find_source, but also searches groups within the
scene.
:param name: The name of the source to find
:return: The scene item if found, otherwise *NULL* if not found
---------------------
.. function:: obs_sceneitem_t *obs_scene_find_sceneitem_by_id(obs_scene_t *scene, int64_t id)
:param id: The unique numeric identifier of the scene item
@ -398,7 +413,7 @@ Scene Item Functions
.. function:: void obs_sceneitem_get_box_transform(const obs_sceneitem_t *item, struct matrix4 *transform)
Gets the transform matrix of the scene item used for the bouding box
Gets the transform matrix of the scene item used for the bounding box
or edges of the scene item.
---------------------
@ -463,7 +478,8 @@ Scene Item Group Functions
.. function:: obs_sceneitem_t *obs_scene_add_group(obs_scene_t *scene, const char *name)
Adds a group with the specified name.
Adds a group with the specified name. Does not signal the scene with
the *refresh* signal.
:param scene: Scene to add the group to
:param name: Name of the group
@ -471,10 +487,23 @@ Scene Item Group Functions
---------------------
.. function:: obs_sceneitem_t *obs_scene_add_group2(obs_scene_t *scene, const char *name, bool signal)
Adds a group with the specified name.
:param scene: Scene to add the group to
:param name: Name of the group
:param signal: If *true*, signals the scene with the *refresh*
signal
:return: The new group's scene item
---------------------
.. function:: obs_sceneitem_t *obs_scene_insert_group(obs_scene_t *scene, const char *name, obs_sceneitem_t **items, size_t count)
Creates a group out of the specified scene items. The group will be
inserted at the top scene item.
inserted at the top scene item. Does not signal the scene with the
*refresh* signal.
:param scene: Scene to add the group to
:param name: Name of the group
@ -484,6 +513,21 @@ Scene Item Group Functions
---------------------
.. function:: obs_sceneitem_t *obs_scene_insert_group2(obs_scene_t *scene, const char *name, obs_sceneitem_t **items, size_t count, bool signal)
Creates a group out of the specified scene items. The group will be
inserted at the top scene item. Does not signal a refresh.
:param scene: Scene to add the group to
:param name: Name of the group
:param items: Array of scene items to put in a group
:param count: Number of scene items in the array
:param signal: If *true*, signals the scene with the *refresh*
signal
:return: The new group's scene item
---------------------
.. function:: obs_sceneitem_t *obs_scene_get_group(obs_scene_t *scene, const char *name)
Finds a group within a scene by its name.
@ -494,6 +538,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
@ -510,9 +561,21 @@ Scene Item Group Functions
.. function:: void obs_sceneitem_group_ungroup(obs_sceneitem_t *group)
Ungroups the specified group. Scene items within the group will be
placed where the group was. Does not signal the scene with the
*refresh* signal.
---------------------
.. function:: void obs_sceneitem_group_ungroup2(obs_sceneitem_t *group, bool signal)
Ungroups the specified group. Scene items within the group will be
placed where the group was.
:param group: Group scene item
:param signal: If *true*, signals the scene with the *refresh*
signal
---------------------
.. function:: void obs_sceneitem_group_add_item(obs_sceneitem_t *group, obs_sceneitem_t *item)
@ -523,8 +586,8 @@ Scene Item Group Functions
.. function:: void obs_sceneitem_group_remove_item(obs_sceneitem_t *item)
Rmoves a scene item from a group. The item will be placed before the
group in the main scene.
Removes a scene item from a group. The item will be placed before
the group in the main scene.
---------------------