summaryrefslogtreecommitdiffstats
path: root/DOCS/client_api_examples/README.md
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2015-01-08 02:40:30 +0100
committerwm4 <wm4@nowhere>2015-01-08 02:40:30 +0100
commitf551fbaa25ac9930c6e5a3df372a4bd7acdd2811 (patch)
tree2bad3f3c5ced87b3e446f11c18f474414aef3af7 /DOCS/client_api_examples/README.md
parentf52ec079b22a4dae732f759ac29746d1d7ca3076 (diff)
downloadmpv-f551fbaa25ac9930c6e5a3df372a4bd7acdd2811.tar.bz2
mpv-f551fbaa25ac9930c6e5a3df372a4bd7acdd2811.tar.xz
DOCS/client_api_examples: add an alternative qml example
This one avoids use of a FBO. It's less flexible, because it uses works around the whole QML rendering API. It seems to be the only way to get OpenGL rendering without any indirections, though. Parts of this example were insipired by Qt's "Squircle" example. Also add a README file with a short description of each example, to reduce the initial confusing.
Diffstat (limited to 'DOCS/client_api_examples/README.md')
-rw-r--r--DOCS/client_api_examples/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/DOCS/client_api_examples/README.md b/DOCS/client_api_examples/README.md
new file mode 100644
index 0000000000..9de90a6748
--- /dev/null
+++ b/DOCS/client_api_examples/README.md
@@ -0,0 +1,30 @@
+Client API examples
+===================
+
+All these examples use the mpv client API through libmpv.
+
+cocoa
+-----
+
+Shows how to embed the mpv video window in Objective-C/Cocoa.
+
+qml
+---
+
+Shows how to use mpv's OpenGL video renderer in QtQuick2 with QML.
+
+qml_direct
+----------
+
+Alternative example, which typically avoids a FBO indirection. Might be
+slightly faster, but is less flexible and harder to use.
+
+qt
+--
+
+Shows how to embed the mpv video window in Qt (using normal desktop widgets).
+
+simple
+------
+
+Very primitive terminal-only example. Shows some most basic API usage.