summaryrefslogtreecommitdiffstats
path: root/libmpv/opengl_cb.h
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2017-03-02 05:53:05 +0100
committerwm4 <wm4@nowhere>2017-03-02 05:53:05 +0100
commit8fb0d2ee27d3e9026d37aa356acd43b567d3df17 (patch)
treeadab6d2de4dace5fc750789367df051a3b668d22 /libmpv/opengl_cb.h
parent9080e4d468d0c50c8f863a873097a7632b48a7d6 (diff)
downloadmpv-8fb0d2ee27d3e9026d37aa356acd43b567d3df17.tar.bz2
mpv-8fb0d2ee27d3e9026d37aa356acd43b567d3df17.tar.xz
client API: update outdated recommendations about window embedding
Basically, the opengl-cb API causes fewer issues, even if it's a bit harder on the API user. See #4197.
Diffstat (limited to 'libmpv/opengl_cb.h')
-rw-r--r--libmpv/opengl_cb.h13
1 files changed, 7 insertions, 6 deletions
diff --git a/libmpv/opengl_cb.h b/libmpv/opengl_cb.h
index e20debc614..fff76526a4 100644
--- a/libmpv/opengl_cb.h
+++ b/libmpv/opengl_cb.h
@@ -31,22 +31,23 @@ extern "C" {
#endif
/**
- * Warning: this API is not stable yet.
*
* Overview
* --------
*
* This API can be used to make mpv render into a foreign OpenGL context. It
- * can be used to handle video display. Be aware that using this API is not
- * required: you can embed the mpv window by setting the mpv "wid" option to
- * a native window handle (see "Embedding the video window" section in the
- * client.h header). In general, using the "wid" option is recommended over
- * the OpenGL API, because it's simpler and more flexible on the mpv side.
+ * can be used to handle video display.
*
* The renderer needs to be explicitly initialized with mpv_opengl_cb_init_gl(),
* and then video can be drawn with mpv_opengl_cb_draw(). The user thread can
* be notified by new frames with mpv_opengl_cb_set_update_callback().
*
+ * You can output and embed video without this API by setting the mpv "wid"
+ * option to a native window handle (see "Embedding the video window" section
+ * in the client.h header). In general, using the opengl-cb API is recommended,
+ * because window embedding can cause various issues, especially with GUI
+ * toolkits and certain platforms.
+ *
* OpenGL interop
* --------------
*