[Bf-docboard-svn] bf-manual: [9758] branches/blender-3.4-release/blender_docs/manual/getting_started/installing: Merge 9751:9754 from trunk

Campbell Barton noreply at blender.org
Wed Dec 7 04:14:00 CET 2022


Revision: 9758
          https://developer.blender.org/rBM9758
Author:   campbellbarton
Date:     2022-12-07 04:14:00 +0100 (Wed, 07 Dec 2022)
Log Message:
-----------
Merge 9751:9754 from trunk

svn merge -r9751:9754 https://svn.blender.org/svnroot/bf-manual/trunk/blender_docs .

Revision Links:
--------------
    https://developer.blender.org/rBM9751

Modified Paths:
--------------
    branches/blender-3.4-release/blender_docs/manual/getting_started/installing/index.rst
    branches/blender-3.4-release/blender_docs/manual/getting_started/installing/linux.rst

Added Paths:
-----------
    branches/blender-3.4-release/blender_docs/manual/getting_started/installing/linux_windowing_environment.rst

Property Changed:
----------------
    branches/blender-3.4-release/blender_docs/

Index: branches/blender-3.4-release/blender_docs
===================================================================
--- branches/blender-3.4-release/blender_docs	2022-12-07 02:34:29 UTC (rev 9757)
+++ branches/blender-3.4-release/blender_docs	2022-12-07 03:14:00 UTC (rev 9758)

Property changes on: branches/blender-3.4-release/blender_docs
___________________________________________________________________
Modified: svn:mergeinfo
## -3,4 +3,5 ##
 /branches/blender-3.0-release/blender_docs:8543-9034
 /branches/blender-3.1-release/blender_docs:8904-9238
 /branches/blender-3.2-release/blender_docs:9236-9417
-/branches/blender-3.3-release/blender_docs:9438-9611
\ No newline at end of property
+/branches/blender-3.3-release/blender_docs:9438-9611
+/trunk/blender_docs:9752-9754
\ No newline at end of property
Modified: branches/blender-3.4-release/blender_docs/manual/getting_started/installing/index.rst
===================================================================
--- branches/blender-3.4-release/blender_docs/manual/getting_started/installing/index.rst	2022-12-07 02:34:29 UTC (rev 9757)
+++ branches/blender-3.4-release/blender_docs/manual/getting_started/installing/index.rst	2022-12-07 03:14:00 UTC (rev 9758)
@@ -72,3 +72,9 @@
    macos.rst
    windows.rst
    steam.rst
+
+.. This is referenced from `linux.rst`, include in a hidden `toctree` to prevent warnings.
+.. toctree::
+   :hidden:
+
+   linux_windowing_environment.rst

Modified: branches/blender-3.4-release/blender_docs/manual/getting_started/installing/linux.rst
===================================================================
--- branches/blender-3.4-release/blender_docs/manual/getting_started/installing/linux.rst	2022-12-07 02:34:29 UTC (rev 9757)
+++ branches/blender-3.4-release/blender_docs/manual/getting_started/installing/linux.rst	2022-12-07 03:14:00 UTC (rev 9758)
@@ -4,7 +4,7 @@
 *******************
 
 Check the :doc:`Downloading Blender </getting_started/installing/index>`
-page to find the minimum requirements and the different versions that are available 
+page to find the minimum requirements and the different versions that are available
 for Blender (if you have not done so yet).
 
 
@@ -58,6 +58,12 @@
 See :doc:`Launching from the terminal </advanced/command_line/launch/linux>`.
 
 
+Graphics System (X11 & Wayland)
+===============================
+
+Blender supports both X11 and Wayland, see :ref:`linux-windowing-environment` for details.
+
+
 Avoiding Alt-Mouse Conflict
 ===========================
 

Copied: branches/blender-3.4-release/blender_docs/manual/getting_started/installing/linux_windowing_environment.rst (from rev 9754, trunk/blender_docs/manual/getting_started/installing/linux_windowing_environment.rst)
===================================================================
--- branches/blender-3.4-release/blender_docs/manual/getting_started/installing/linux_windowing_environment.rst	                        (rev 0)
+++ branches/blender-3.4-release/blender_docs/manual/getting_started/installing/linux_windowing_environment.rst	2022-12-07 03:14:00 UTC (rev 9758)
@@ -0,0 +1,118 @@
+.. _linux-windowing-environment:
+
+***************************
+Linux Windowing Environment
+***************************
+
+On Linux Blender supports both X11 and Wayland for official releases.
+
+When Wayland is detected, is is the preferred system, otherwise X11 will be used.
+
+.. hint::
+
+   The current "Windowing Environment" is listed in :menuselection:`File --> About`.
+
+
+X11
+===
+
+This is the windowing environment that has been used most widely on Linux & Unix systems.
+
+There are no near-term plans to deprecate or remove X11 support.
+
+
+Wayland
+=======
+
+Support for Wayland is a more recent addition, so there may be configurations that have not been tested yet.
+Please report a bug if you experience problems.
+
+Blender has been tested with Gnome-Shell (mutter), KDE (plasma) & SWAY (wlroots) based compositors.
+
+
+Requirements
+------------
+
+Gnome-Shell
+   Under Gnome-Shell the ``libdecor`` library is required.
+   This is available as a package on most Linux distribution.
+
+   If the library isn't found X11 will be used as a fallback.
+
+
+Troubleshooting
+---------------
+
+Detailed Wayland output can help to track down problems.
+Launch Blender from the :doc:`command-line </advanced/command_line/launch/linux>` with additional arguments:
+
+Blender's Wayland Logging
+   .. code-block:: sh
+
+      blender --log "ghost.wl.*" --log-level 2
+
+Wayland Built-In Logging
+   .. code-block:: sh
+
+      WAYLAND_DEBUG=1 blender
+
+
+Known Limitations
+-----------------
+
+NVidia GPU
+   Currently NVidia drivers don't fully support features needed for Wayland support,
+   graphical glitches and flickering is a common problem, this is not specific to Blender
+   so NVidia users may want to use X11 until driver support improves.
+
+----
+
+Feature Comparison
+==================
+
+.. |tick|  unicode:: U+2713
+.. |cross| unicode:: U+2717
+.. |none|  unicode:: U+2014
+
+.. list-table::
+   :header-rows: 1
+   :class: valign
+   :widths: 30 5 5 60
+
+   * - Feature
+     - X11
+     - Wayland
+     - Notes
+   * - Smooth Scroll
+     - |cross|
+     - |tick|
+     - | Smooth scrolling with track-pads.
+   * - Multi-Touch Gestures
+     - |cross|
+     - |tick|
+     - | Track-pad and tablet support for
+       | pinch to zoom, pan and orbit.
+   * - Reliable Cursor Warping
+     - |cross| :sup:`*1`
+     - |tick|
+     - | Track-pad and tablet support for
+       | pinch to zoom, pan and orbit.
+   * - Window Positioning
+     - |tick|
+     - |cross| :sup:`*2`
+     - | Needed for dragging between windows and
+       | restoring window positions on file load.
+   * - Window Raise/Lower
+     - |tick|
+     - |cross| :sup:`*2`
+     - | Used to bring the render window
+       | to the foreground.
+
+Other features which both systems support such as Hi-DPI, 3D-mouse, tablet input, ... etc.
+have been left out of this list.
+
+| :sup:`*1` In X11 fast cursor motion may exit the window bounds while the cursor is grabbed (transforming for e.g.).
+| :sup:`*2` Wayland doesn't support setting the window position & depth,
+  as this is a design decision it's unlikely to be supported (see issues for
+  `position <https://developer.blender.org/T98928>`__ and
+  `depth <https://developer.blender.org/T102985>`__).



More information about the Bf-docboard-svn mailing list