jp9000/obs-studio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

libobs: Clarify filter-related comments

Browse Source 
Certain callbacks and API functions were a bit vague on when and how
they were supposed to be used.
This commit is contained in:
jp9000
2015-03-07 09:37:07 -08:00
parent 38cb1ed39b
commit 76a9c90043
2 changed files with 17 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
libobs/obs.h
View File

@@ -674,10 +674,18 @@ EXPORT uint32_t obs_source_get_width(obs_source_t *source);
/** Gets the height of a source (if it has video) */
EXPORT uint32_t obs_source_get_height(obs_source_t *source);
/** If the source is a filter, returns the parent source of the filter */
/**
* If the source is a filter, returns the parent source of the filter. Only
* guaranteed to be valid inside of the video_render, filter_audio,
* filter_video, and filter_remove callbacks.
*/
EXPORT obs_source_t *obs_filter_get_parent(const obs_source_t *filter);
/** If the source is a filter, returns the target source of the filter */
/**
* If the source is a filter, returns the target source of the filter. Only
* guaranteed to be valid inside of the video_render, filter_audio,
* filter_video, and filter_remove callbacks.
*/
EXPORT obs_source_t *obs_filter_get_target(const obs_source_t *filter);
/** Adds a filter to the source (which is used whenever the source is used) */