From cafc03e0dfcf0bec08b71f5b4472838445c3a3d4 Mon Sep 17 00:00:00 2001
From: "F. Duncanh"
Date: Fri, 10 May 2024 15:11:53 -0400
Subject: [PATCH] Update README with new fullscreen option for d3d11videosink
(Windows)
---
README.html | 33 ++++++++++++++++++++-------------
README.md | 17 ++++++++++++-----
README.txt | 40 +++++++++++++++++++++++-----------------
3 files changed, 55 insertions(+), 35 deletions(-)
diff --git a/README.html b/README.html
index 74a78a2..aa61121 100644
--- a/README.html
+++ b/README.html
@@ -451,11 +451,12 @@ omitting the initial "-" of the command-line option. Lines
in the configuration file beginning with "#" are treated as
comments and ignored.
Run uxplay in a terminal window. On some systems,
-you can toggle into and out of fullscreen mode with F11 or (held-down
-left Alt)+Enter keys. Use Ctrl-C (or close the window) to terminate it
-when done. If the UxPlay server is not seen by the iOS client’s
-drop-down “Screen Mirroring” panel, check that your DNS-SD server
-(usually avahi-daemon) is running: do this in a terminal window with
+you can specify fullscreen mode with the -fs option, or
+toggle into and out of fullscreen mode with F11 or (held-down left
+Alt)+Enter keys. Use Ctrl-C (or close the window) to terminate it when
+done. If the UxPlay server is not seen by the iOS client’s drop-down
+“Screen Mirroring” panel, check that your DNS-SD server (usually
+avahi-daemon) is running: do this in a terminal window with
systemctl status avahi-daemon. If this shows the
avahi-daemon is not running, control it with
sudo systemctl [start,stop,enable,disable] avahi-daemon (on
@@ -867,14 +868,20 @@ used.
-vs <videosink> option, some choices for
<videosink> are d3d11videosink,
d3dvideosink, glimagesink,
-gtksink. With Direct3D 11.0 or greater, you can get the
-ability to toggle into and out of fullscreen mode using the Alt-Enter
-key combination with option
+gtksink.
+
+- With Direct3D 11.0 or greater, you can either always be in
+fullscreen mode using option
+
-vs "d3d11videosink fullscreen-toggle-mode=property fullscreen=true",
+or get the ability to toggle into and out of fullscreen mode using the
+Alt-Enter key combination with option
-vs "d3d11videosink fullscreen-toggle-mode=alt-enter". For
-convenience, this option will be added if just
--vs d3d11videosink (by itself) is used. (You may wish to
-add “vs d3d11videosink” (no initial “-”) to
-the UxPlay startup options file; see “man uxplay” or “uxplay -h”.)
+convenience, these options will be added if just
+-vs d3d11videosink with or without the fullscreen option
+“-fs” is used. (Windows users may wish to add
+“vs d3d11videosink” (no initial “-”) to the
+UxPlay startup options file; see “man uxplay” or “uxplay -h”.)
+
The executable uxplay.exe can also be run without the MSYS2
environment, in the Windows Terminal, with
C:\msys64\mingw64\bin\uxplay.
@@ -988,7 +995,7 @@ full-screen display that overscans, and is not displayed by gstreamer).
Recommendation: don’t use this option unless there is
some special reason to use it.
-fs uses fullscreen mode, but only works with X11,
-Wayland or VAAPI.
+Wayland, VAAPI, and D3D11 (Windows).
-p allows you to select the network ports used by
UxPlay (these need to be opened if the server is behind a firewall). By
itself, -p sets “legacy” ports TCP 7100, 7000, 7001, UDP 6000, 6001,
diff --git a/README.md b/README.md
index f4f1576..3377cbc 100644
--- a/README.md
+++ b/README.md
@@ -369,7 +369,8 @@ Since UxPlay-1.64, UxPlay can be started with options read from a configuration
directory ("~"), (3) ``~/.config/uxplayrc``. The format is one option per line, omitting the initial ``"-"`` of
the command-line option. Lines in the configuration file beginning with `"#"` are treated as comments and ignored.
-**Run uxplay in a terminal window**. On some systems, you can toggle into and out of fullscreen mode
+**Run uxplay in a terminal window**. On some systems, you can specify fullscreen mode with the `-fs` option, or
+toggle into and out of fullscreen mode
with F11 or (held-down left Alt)+Enter keys. Use Ctrl-C (or close the window)
to terminate it when done. If the UxPlay server is not seen by the
iOS client's drop-down "Screen Mirroring" panel, check that your DNS-SD
@@ -695,9 +696,15 @@ default audio device is used.
If you wish to specify the videosink using the `-vs ` option, some choices for `` are
`d3d11videosink`, ``d3dvideosink``, ```glimagesink```,
-`gtksink`. With Direct3D 11.0 or greater, you can get the ability to toggle into and out of fullscreen mode using the Alt-Enter key combination with
-option `-vs "d3d11videosink fullscreen-toggle-mode=alt-enter"`. For convenience, this option will be added if just ``-vs d3d11videosink`` (by itself) is used.
-(You may wish to add "``vs d3d11videosink``" (no initial "`-`") to the UxPlay startup options file; see "man uxplay" or "uxplay -h".)
+`gtksink`.
+
+* With Direct3D 11.0 or greater, you can either always be in fullscreen mode using
+option `-vs "d3d11videosink fullscreen-toggle-mode=property fullscreen=true"`, or
+get the ability to toggle into and out of fullscreen mode using the Alt-Enter key combination with
+option `-vs "d3d11videosink fullscreen-toggle-mode=alt-enter"`.
+For convenience, these options will be added if just ``-vs d3d11videosink`` with or without the fullscreen
+option "-fs" is used. _(Windows users may wish to add "``vs d3d11videosink``" (no initial "`-`") to the
+UxPlay startup options file; see "man uxplay" or "uxplay -h".)_
The executable uxplay.exe can also be run without the MSYS2 environment, in
the Windows Terminal, with `C:\msys64\mingw64\bin\uxplay`.
@@ -783,7 +790,7 @@ using UxPlay as a second monitor for a mac computer, or monitoring a webcam; wit
Recommendation: **don't use this option** unless there is some special
reason to use it.
-**-fs** uses fullscreen mode, but only works with X11, Wayland or VAAPI.
+**-fs** uses fullscreen mode, but only works with X11, Wayland, VAAPI, and D3D11 (Windows).
**-p** allows you to select the network ports used by UxPlay (these need
to be opened if the server is behind a firewall). By itself, -p sets
diff --git a/README.txt b/README.txt
index 8320e8e..6532296 100644
--- a/README.txt
+++ b/README.txt
@@ -445,14 +445,14 @@ one option per line, omitting the initial `"-"` of the command-line
option. Lines in the configuration file beginning with `"#"` are treated
as comments and ignored.
-**Run uxplay in a terminal window**. On some systems, you can toggle
-into and out of fullscreen mode with F11 or (held-down left Alt)+Enter
-keys. Use Ctrl-C (or close the window) to terminate it when done. If the
-UxPlay server is not seen by the iOS client's drop-down "Screen
-Mirroring" panel, check that your DNS-SD server (usually avahi-daemon)
-is running: do this in a terminal window with
-`systemctl status avahi-daemon`. If this shows the avahi-daemon is not
-running, control it with
+**Run uxplay in a terminal window**. On some systems, you can specify
+fullscreen mode with the `-fs` option, or toggle into and out of
+fullscreen mode with F11 or (held-down left Alt)+Enter keys. Use Ctrl-C
+(or close the window) to terminate it when done. If the UxPlay server is
+not seen by the iOS client's drop-down "Screen Mirroring" panel, check
+that your DNS-SD server (usually avahi-daemon) is running: do this in a
+terminal window with `systemctl status avahi-daemon`. If this shows the
+avahi-daemon is not running, control it with
`sudo systemctl [start,stop,enable,disable] avahi-daemon` (on
non-systemd systems, such as \*BSD, use
`sudo service avahi-daemon [status, start, stop, restart, ...]`). If
@@ -871,14 +871,19 @@ like `\{0.0.0.00000000\}.\{98e35b2b-8eba-412e-b840-fd2c2492cf44\}`. If
If you wish to specify the videosink using the `-vs ` option,
some choices for `` are `d3d11videosink`, `d3dvideosink`,
-`glimagesink`, `gtksink`. With Direct3D 11.0 or greater, you can get the
-ability to toggle into and out of fullscreen mode using the Alt-Enter
-key combination with option
-`-vs "d3d11videosink fullscreen-toggle-mode=alt-enter"`. For
-convenience, this option will be added if just `-vs d3d11videosink` (by
-itself) is used. (You may wish to add "`vs d3d11videosink`" (no initial
-"`-`") to the UxPlay startup options file; see "man uxplay" or "uxplay
--h".)
+`glimagesink`, `gtksink`.
+
+- With Direct3D 11.0 or greater, you can either always be in
+ fullscreen mode using option
+ `-vs "d3d11videosink fullscreen-toggle-mode=property fullscreen=true"`,
+ or get the ability to toggle into and out of fullscreen mode using
+ the Alt-Enter key combination with option
+ `-vs "d3d11videosink fullscreen-toggle-mode=alt-enter"`. For
+ convenience, these options will be added if just
+ `-vs d3d11videosink` with or without the fullscreen option "-fs" is
+ used. *(Windows users may wish to add "`vs d3d11videosink`" (no
+ initial "`-`") to the UxPlay startup options file; see "man uxplay"
+ or "uxplay -h".)*
The executable uxplay.exe can also be run without the MSYS2 environment,
in the Windows Terminal, with `C:\msys64\mingw64\bin\uxplay`.
@@ -998,7 +1003,8 @@ display that overscans, and is not displayed by gstreamer).
Recommendation: **don't use this option** unless there is some special
reason to use it.
-**-fs** uses fullscreen mode, but only works with X11, Wayland or VAAPI.
+**-fs** uses fullscreen mode, but only works with X11, Wayland, VAAPI,
+and D3D11 (Windows).
**-p** allows you to select the network ports used by UxPlay (these need
to be opened if the server is behind a firewall). By itself, -p sets