Skip to content

Commit

Permalink
docs: Add documentation for filter index functions
Browse files Browse the repository at this point in the history
Adds documentation for the obs_source_filter_set_index and
obs_source_filter_get_index functions.
  • Loading branch information
cg2121 authored and Lain-B committed Jul 23, 2023
1 parent 4c5d3e7 commit 40d15d4
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/sphinx/reference-sources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1586,6 +1586,19 @@ Filters
---------------------

.. function:: void obs_source_filter_set_index(obs_source_t *source, obs_source_t *filter, size_t index)

Moves a filter to the specified index in the filters array.

:param index: | The index to move the filter to.

---------------------

.. function:: int obs_source_filter_get_index(obs_source_t *source, obs_source_t *filter)

Gets the index of the specified filter.

:return: Index of the filter or -1 if it is invalid/not found.

Functions used by filters
-------------------------
Expand Down

0 comments on commit 40d15d4

Please sign in to comment.