diff --git a/docs/sphinx/reference-core.rst b/docs/sphinx/reference-core.rst index 7cfb564f3..7f186d585 100644 --- a/docs/sphinx/reference-core.rst +++ b/docs/sphinx/reference-core.rst @@ -278,6 +278,8 @@ Libobs Objects :c:func:`obs_source_get_weak_source()` if you want to retain a reference after obs_enum_sources finishes. + For scripting, use :py:func:`obs_enum_sources`. + --------------------- .. function:: void obs_enum_scenes(bool (*enum_proc)(void*, obs_source_t*), void *param) @@ -522,6 +524,9 @@ Video, Audio, and Graphics Adds/removes a main rendering callback. Allows custom rendering to the main stream/recording output. + For scripting (**Lua only**), use :py:func:`obs_add_main_render_callback` + and :py:func:`obs_remove_main_render_callback`. + --------------------- .. function:: void obs_add_raw_video_callback(const struct video_scale_info *conversion, void (*callback)(void *param, struct video_data *frame), void *param) diff --git a/docs/sphinx/reference-libobs-callback.rst b/docs/sphinx/reference-libobs-callback.rst index ae2d5346b..533e6f3ca 100644 --- a/docs/sphinx/reference-libobs-callback.rst +++ b/docs/sphinx/reference-libobs-callback.rst @@ -194,6 +194,8 @@ Signals are used for all event-based callbacks. :param callback: Signal callback :param data: Private data passed the callback + For scripting, use :py:func:`signal_handler_connect`. + --------------------- .. function:: void signal_handler_connect_ref(signal_handler_t *handler, const char *signal, signal_callback_t callback, void *data) @@ -216,6 +218,8 @@ Signals are used for all event-based callbacks. :param callback: Signal callback :param data: Private data passed the callback + For scripting, use :py:func:`signal_handler_disconnect`. + --------------------- .. function:: void signal_handler_signal(signal_handler_t *handler, const char *signal, calldata_t *params) diff --git a/docs/sphinx/reference-properties.rst b/docs/sphinx/reference-properties.rst index b8d4b8a4f..9fc5ebdea 100644 --- a/docs/sphinx/reference-properties.rst +++ b/docs/sphinx/reference-properties.rst @@ -253,6 +253,8 @@ Property Object Functions - :c:func:`obs_property_button_set_type` - :c:func:`obs_property_button_set_url` + For scripting, use :py:func:`obs_properties_add_button`. + Relevant data types used with this function: .. code:: cpp diff --git a/docs/sphinx/reference-scenes.rst b/docs/sphinx/reference-scenes.rst index 86eae5c8e..dab97e862 100644 --- a/docs/sphinx/reference-scenes.rst +++ b/docs/sphinx/reference-scenes.rst @@ -266,6 +266,8 @@ General Scene Functions Enumerates scene items within a scene. + For scripting, use :py:func:`obs_scene_enum_items`. + --------------------- .. function:: bool obs_scene_reorder_items(obs_scene_t *scene, obs_sceneitem_t * const *item_order, size_t item_order_size)