summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2018-04-27 12:03:43 +0200
committerJan Ekström <jeebjp@gmail.com>2018-04-29 02:21:32 +0300
commitfff5fda74b4fd151b2fa488f34a55a3c7dda9990 (patch)
tree2b192bb9f244cdd7d19db9df7776a39738734f7e
parenteb33556cbffae5a3514be1de18b8abcd8f754090 (diff)
downloadmpv-fff5fda74b4fd151b2fa488f34a55a3c7dda9990.tar.bz2
mpv-fff5fda74b4fd151b2fa488f34a55a3c7dda9990.tar.xz
client API: some doxygen clarifications
Strictly speaking redundant, but probably helpful. In particular I want to push MPV_RENDER_PARAM_ADVANCED_CONTROL. Not enabling this parameter is actually not very sane.
-rw-r--r--libmpv/render.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/libmpv/render.h b/libmpv/render.h
index acd50cd03e..5a39d4e1c6 100644
--- a/libmpv/render.h
+++ b/libmpv/render.h
@@ -396,6 +396,13 @@ typedef struct mpv_render_frame_info {
* Currently, only at most 1 context can exists per mpv core (it represents the
* main video output).
*
+ * You should pass the following parameters:
+ * - MPV_RENDER_PARAM_API_TYPE to select the underlying backend/GPU API.
+ * - Backend-specific init parameter, like MPV_RENDER_PARAM_OPENGL_INIT_PARAMS.
+ * - Setting MPV_RENDER_PARAM_ADVANCED_CONTROL and following its rules is
+ * strongly recommended.
+ * - If you want to use hwdec, possibly hwdec interop resources.
+ *
* @param res set to the context (on success) or NULL (on failure). The value
* is never read and always overwritten.
* @param mpv handle used to get the core (the mpv_render_context won't depend
@@ -534,6 +541,10 @@ typedef enum mpv_render_update_flag {
* this by setting the "video-timing-offset" global option to 0. (This applies
* only to "audio" video sync mode.)
*
+ * You should pass the following parameters:
+ * - Backend-specific target object, such as MPV_RENDER_PARAM_OPENGL_FBO.
+ * - Possibly transformations, such as MPV_RENDER_PARAM_FLIP_Y.
+ *
* @param ctx a valid render context
* @param params an array of parameters, terminated by type==0. Which parameters
* are required depends on the backend. It's left unspecified what