summaryrefslogtreecommitdiffstats
path: root/DOCS/man
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-10-09 19:35:43 +0200
committerwm4 <wm4@nowhere>2014-10-09 20:17:52 +0200
commit89890192711e1478e7626df6f8eb2a7ecb117342 (patch)
treee07cbbd2ca5a747175b5ebc2233b3043faf413f8 /DOCS/man
parente294656cb11082a77f2e785fb55ddafa926bbc47 (diff)
downloadmpv-89890192711e1478e7626df6f8eb2a7ecb117342.tar.bz2
mpv-89890192711e1478e7626df6f8eb2a7ecb117342.tar.xz
manpage: improve --wid description
In particular, add a basic description of how Cocoa embedding works.
Diffstat (limited to 'DOCS/man')
-rw-r--r--DOCS/man/options.rst27
1 files changed, 19 insertions, 8 deletions
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
index f0bd8aac66..a59e1b8060 100644
--- a/DOCS/man/options.rst
+++ b/DOCS/man/options.rst
@@ -1692,14 +1692,25 @@ Window
to to work this around using ``--heartbeat-cmd`` instead.
``--wid=<ID>``
- (X11 and Windows only)
- This tells mpv to attach to an existing window. The ID is interpreted as
- "Window" on X11, and as HWND on Windows. If a VO is selected that supports
- this option, a new window will be created and the given window will be set
- as parent. The window will always be resized to cover the parent window
- fully, and will add black bars to compensate for the video aspect ratio.
-
- See also ``--slave-broken``.
+ This tells mpv to attach to an existing window. If a VO is selected that
+ supports this option, it will use that window for video output. mpv will
+ scale the video to the size of this window, and will add black bars to
+ compensate if the aspect ratio of the video is different.
+
+ On X11, the ID is interpreted as a ``Window`` on X11. Unlike
+ MPlayer/mplayer2, mpv always creates its own window, and sets the wid
+ window as parent. The window will always be resized to cover the parent
+ window fully. The value ``0`` is interpreted specially, and mpv will
+ draw directly on the root window.
+
+ On win32, the ID is interpreted as ``HWND``. Pass it as value cast to
+ ``intptr_t``. mpv will create its own window, and set the wid window as
+ parent, like with X11.
+
+ On OSX/Cocoa. the ID is interpreted as ``NSView*``. Pass it as value cast
+ to ``intptr_t``. mpv will creates its own sub-view. Because OSX does not
+ support window embedding of foreign processes, this works only with libmpv,
+ and will crash when used from the command line.
``--no-window-dragging``
Don't move the window when clicking on it and moving the mouse pointer.