浏览代码

docs: Fix frontend API docs for preview_scene functions

gxalpha 3 年之前
父节点
当前提交
3fb2e27825
共有 1 个文件被更改,包括 3 次插入4 次删除
  1. 3 4
      docs/sphinx/reference-frontend-api.rst

+ 3 - 4
docs/sphinx/reference-frontend-api.rst

@@ -659,15 +659,14 @@ Functions
 .. function:: obs_source_t *obs_frontend_get_current_preview_scene(void)
 .. function:: obs_source_t *obs_frontend_get_current_preview_scene(void)
 
 
    :return: A new reference to the current preview scene if studio mode
    :return: A new reference to the current preview scene if studio mode
-            is active, or the current scene if studio mode is not
-            active
+            is active, or *NULL* if studio mode is not active.
 
 
 ---------------------------------------
 ---------------------------------------
 
 
 .. function:: void obs_frontend_set_current_preview_scene(obs_source_t *scene)
 .. function:: void obs_frontend_set_current_preview_scene(obs_source_t *scene)
 
 
-   Sets the current preview scene in studio mode, or the currently
-   active scene if not in studio mode.
+   Sets the current preview scene in studio mode. Does nothing if studio
+   mode is disabled.
 
 
    :param scene: The scene to set as the current preview
    :param scene: The scene to set as the current preview