Bläddra i källkod

docs: Add documentation for filter index functions

Adds documentation for the obs_source_filter_set_index and
obs_source_filter_get_index functions.
cg2121 2 år sedan
förälder
incheckning
40d15d4b86
1 ändrade filer med 13 tillägg och 0 borttagningar
  1. 13 0
      docs/sphinx/reference-sources.rst

+ 13 - 0
docs/sphinx/reference-sources.rst

@@ -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
 Functions used by filters
 -------------------------
 -------------------------