From b9885f05dbffddb2baa3e44e13a6119cd5ccf50c Mon Sep 17 00:00:00 2001 From: Exeldro Date: Sun, 12 Mar 2023 08:50:22 +0100 Subject: [PATCH] docs: Add view functions --- docs/sphinx/reference-core.rst | 63 ++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) diff --git a/docs/sphinx/reference-core.rst b/docs/sphinx/reference-core.rst index b6d0720e1..5ea5dbaff 100644 --- a/docs/sphinx/reference-core.rst +++ b/docs/sphinx/reference-core.rst @@ -806,3 +806,66 @@ Displays .. function:: void obs_display_set_background_color(obs_display_t *display, uint32_t color) Sets the background (clear) color for the display context. + +.. _view_reference: + +Views +---------------- + +.. function:: obs_view_t *obs_view_create(void) + + :return: A view context + +--------------------- + +.. function:: void obs_view_destroy(obs_view_t *view) + + Destroys a view context. + +--------------------- + +.. function:: void obs_view_render(obs_view_t *view) + + Renders the sources of this view context. + +--------------------- + +.. function:: video_t *obs_view_add(obs_view_t *view) + + Renders the sources of this view context. + + :return: The main video output handler for the view context + +--------------------- + +.. function:: video_t *obs_view_add2(obs_view_t *view, struct obs_video_info *ovi) + + Adds a view to the main render loop, with custom video settings. + + :return: The main video output handler for the view context + +--------------------- + +.. function:: void obs_view_remove(obs_view_t *view) + + Removes a view from the main render loop. + +--------------------- + +.. function:: void obs_view_set_source(obs_view_t *view, uint32_t channel, obs_source_t *source) + + Sets the source to be used for this view context. + +--------------------- + +.. function:: obs_source_t *obs_view_get_source(obs_view_t *view, uint32_t channel) + + :return: The source currently in use for this view context + +--------------------- + +.. function:: bool obs_view_get_video_info(obs_view_t *view, struct obs_video_info *ovi) + + Gets the video settings currently in use for this view context. + + :return: *false* if no video