// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
    \page highdpi.html
    \title High DPI
    \brief Describes Qt's support for high DPI displays.

    High-DPI displays – also known as retina displays – are displays with high
    resolution (pixels) in relation to their physical size (mm), resulting in a
    high pixel density, or high number of \e{dots per inch} (DPI). The increased
    resolution is used to provide more detailed content on screen (smoother
    text, more detailed icons), rather than more content (more windows, larger
    window sizes).

    Qt supports high-DPI displays on all platforms and provides a unified API
    that abstracts over any platform differences. Qt automatically accounts
    for the display resolution when using higher-level APIs such as
    \l{Qt Widgets} and \l{Qt Quick}, and applications only need to provide
    high-resolution assets, such as images and icons. Changes in the platform's
    user preferences are automatically picked up.

    Lower-level graphics drawing (such as OpenGL code) needs to be high-DPI
    aware, but can use cross-platform Qt APIs to learn about the platform's
    display resolutions.

    \section1 Conceptual Model

    Qt uses a model where the application coordinate system is independent of
    the display device resolution. The application operates in
    \e{device-independent pixels}, which are then mapped to the physical pixels
    of the display via a scale factor, known as the \e{device pixel ratio}. The
    scale factor is expressed as a floating point number, for example \c 1.0 or
    \c 2.0, or informally as \c 1x and \c 2x.

    For example, creating a QWindow or QWidget, and setting its size to 200x200
    covers 200x200 display pixels on a standard density display (with a device
    pixel ratio of 1.0), but covers 400x400 pixels on a high-density display
    (with a device pixel ratio of 2.0).

    This model applies to most units in higher-level Qt GUI, Widgets, and Quick
    APIs, including widget and item geometry, event geometry, desktop, window,
    and screen geometry, as well as animation velocities.

    \note The model does not handle differences between UI classes, such as the
    size of touch targets vs mouse targets.

    \section1 Drawing

    Qt automatically takes advantage of the increased density of a high-DPI
    display when using drawing APIs such as QPainter, or when rendering graphic
    primitives or text in Qt Quick.

    As a result, the application can operate in a single unified coordinate
    system, without needing to account for the possible display densities the
    application runs on.

    However, when using lower-level drawing APIs, for example, OpenGL, the
    application needs to take the device pixel ratio of the display into
    account. This is available both per window, as QWindow::devicePixelRatio()
    (tracking the device pixel ratio of the window when moved between displays),
    or per display, as QScreen::devicePixelRatio().

    Image buffers such as QImage and QPixmap represent the raw pixels, and
    as a result do not operate in the device-independent coordinate system
    described earlier. A QImage of size 400x400, with a device pixel ratio
    of 2.0, fits a 200x200 QWindow on a high-density (2x) display, or
    is automatically down-scaled to 200x200 during drawing if targeting
    a standard density (1x) display. See \l{Drawing High Resolution Versions
    of Pixmaps and Images} for more details.

    \section1 Image Assets

    To take advantage of the increased pixel density of high-DPI displays,
    the application should also include high-DPI versions of static image
    assets. This is achieved by using a special naming convention for the
    high-density assets, for example, \c logo@2x.png, and loading both the
    normal density image and the high-density image into a QIcon. Qt
    automatically chooses the best representation for the target display at
    runtime. See \l{High DPI Icons} for more details.

    \section1 Device Independent Screen Geometry

    Qt applications generally operate in device-independent pixels. This
    includes window and screen geometries reported to the application.

    This means that QScreen::geometry() may not return the screen's physical
    pixel count, or the pixel size as reported by the operating system. This
    has implications for virtual desktop geometry:

    Modern desktop operating systems typically create one shared coordinate
    system for all connected screens and allow the user to position screens to
    match their physical screen setup, usually via a configuration dialog. If
    this positioning is done in a coordinate system equivalent to Qt's
    device-independent pixels (like on macOS) then QScreen geometry matches the
    native screen layout. If the positioning is done in screen physical pixels
    (like on Windows), then Qt's treatment of screen geometry may introduce
    gaps in virtual desktop geometry unused by any screen.

    Specifically, Qt scales the screen size (resulting in a "smaller" screen
    for positive scale factors), but doesn't change the screen position. This
    produces an islands-of-screens type virtual desktop geometry.

    Application code should not assume that a position immediately adjacent to
    and outside one screen is a valid position on the neighboring screen.
    Instead, get the screen list using QGuiApplication::screens() and use that
    list to reason about available screen geometry.

    \section1 Configuring

    You may want to adjust the DPI or scale settings to
    match display hardware, or to account for viewing distance and personal
    preferences. These adjustments should be done using the native display
    settings of the platform, so that all applications agree on the same
    DPI or scale factor values. Qt does not provide end-user facilities to
    configure the behavior of Qt's high-DPI support.

    The operating system may represent the scale factor either as a factor
    (1.5), as a percentage (150%), or as dots per inch (144 DPI). Qt translates
    these to the device pixel ratio seen by the application. In the latter case
    Qt assumes a "base" DPI – for example, 96 on X11 – and calculates the
    resulting device pixel ratio accordingly.

    Integer scale factors (for example, 1.0 or 2.0) are preferred for best
    results. "Rounding" the scale factor to 25% increments can also give good
    results. Setting the scale factor or DPI to the exact physical display DPI
    may not give good visual results due to the fractional scaling involved.
    If the application suffers from visual artifacts in this scenario, it can
    use QGuiApplication::setHighDpiScaleFactorRoundingPolicy() to limit the
    scale factors it sees.

    \section2 Platform Details

    The following table describes how to configure high-DPI on various
    platforms:

    \table
        \header
            \li Platform
            \li Configuration
        \row
            \li \macos
            \li Set the scale for each display in the display preferences.
                \macos reflects this to Qt as an integer device pixel ratio.
        \row
            \li Windows
            \li Set the scale factor for each display in the display settings.
                The base scale factor is 100%, and can be adjusted in 25% steps.
                See \l{Configuring Windows}.
        \row
            \li Ubuntu
            \li Set the scale factor in display settings. On Ubuntu 20.04 and
                later, this can be done per display in increments of 25%.
        \row
            \li X11
            \li Set Xft.dpi, or opt-in to use physical DPI.
                See \l {Configuring X11}.
        \row
            \li Wayland
            \li Qt reads \c{wl_output::scale}, which is restricted to integer
                values. Wayland compositors typically have a configuration
                option for setting the scale factor, for example,
                \c{weston --scale}.
        \row
            \li EGLFS
            \li Set \c QT_FONT_DPI to the desired logical DPI value,
            for example, \c{QT_FONT_DPI=192}. Qt assumes that the base DPI is
            96, and scales the UI accordingly.
    \endtable

    \note Some windowing systems may have limitations that are then reflected
    in Qt. Qt does not provide workarounds for these limitations. Instead,
    consider workarounds on the windowing system level.

    \section2 Configuring X11

    The required configuration input to Qt is per-screen logical DPI. Currently,
    X11 provides either global logical DPI or per-screen physical DPI. Neither
    of these are exactly what Qt needs, which can make DPI configuration on
    X11 more complicated than on other platforms.

    Desktop environments such as Ubuntu and Kubuntu implement workarounds for
    the lack of logical DPI, and provide easily configurable high-DPI support.
    If you instead want to configure X11 DPI settings manually, then this
    section describes which X11 settings Qt reads.

    Some X11 configuration workflows involve overriding the reported physical
    size of the screen to make DPI calculations yield a specific DPI value. Qt
    supports this workflow, but this requires opting in, as described below.

    The exact configuration priority is as follows, where Qt uses the first
    option available.

    \table
    \header
         \li {3,1} X11 DPI Configuration Priority
    \header
        \li Priority
        \li Property
        \li Description
    \row
        \li 1
        \li Xft/DPI
        \li From X settings. Global logical DPI value.
    \row
        \li 2
        \li Xft.dpi
        \li From X resources. Global logical DPI value.
    \row
        \li 3
        \li RandR physical DPI
            (Qt 5 Only)
        \li DPI calculated from per-screen physical size and pixel size, as
            reported by \c randr. Specifically, the \c mwidth and \c mheight
            fields of the \c xcb_randr_screen_change_notify_event_t
            structure is used. DPI is rounded to an integer and clamped to be
            not less than 96.
    \row
        \li 4
        \li 96 DPI
        \li Fallback value.
    \endtable

    \section3 Using Physical DPI on X11

    To force Qt to use RandR physical DPI unconditionally instead of logical
    DPI, set \c{QT_USE_PHYSICAL_DPI=1}. Qt then reads the \c mwidth and
    \c mheight fields of the \c xcb_randr_screen_change_notify_event_t structure
    and rounds the resulting DPI value to an integer.

    This is useful when logical DPI is unavailable and the physical DPI of the
    display is known to be correct. See also \l{Environment Variable Reference}.

    \section2 Configuring Windows


    Qt uses the Windows display scale settings automatically; no specific
    settings are required. For example, if a display is configured for
    175% scale, then Qt apps see a device pixel ratio of 1.75 on that screen.

    Windows defines several \l{https://docs.microsoft.com/en-us/windows/win32/hidpi/high-dpi-desktop-application-development-on-windows}
    {DPI Awareness} levels, which applications set to opt-in to high-DPI
    features. Qt 6 is Per-Monitor DPI Aware V2 by default. If you are
    incorporating code that assumes a single global DPI, then you might want to
    set a different awareness level. To do this, add the following to
    \c{qt.conf}:

    \badcode
    [Platforms]
    WindowsArguments = dpiawareness=0,1,2
    \endcode

    \section1 Testing

    When developing or debugging high-DPI support, it is often impractical to
    rely on specific hardware. Qt provides an environment variable to simulate
    different scale factors, and a test application to inspect how Qt interprets
    the current display configuration.

    \section2 QT_SCALE_FACTOR

    Set the \c QT_SCALE_FACTOR environment variable to provide a global scale
    factor for the application.

    For example:

    \badcode
        QT_SCALE_FACTOR=2 ./myapp
    \endcode

    This scales all application geometry (including the device pixel ratio) by
    the given factor, which enables testing high-DPI support independently of
    available hardware.

    The set scale factor is used as-is by Qt and isn't affected by the
    \l{Qt::HighDpiScaleFactorRoundingPolicy}{rounding policy}.

    The effective device pixel ratio, as returned by
    QWindow::devicePixelRatio(), is a product of the set scale factor and the
    native device pixel ratio. For example, setting \c QT_SCALE_FACTOR=2
    on a 2x Wayland display results in the application seeing a device
    pixel ratio of 4.

    \section2 DprGadget Test Application

    You can use the DprGadget test application to inspect the native
    configuration, and how Qt reacts to it:

    \image dprgadget.png

    DprGadget displays the device pixel ratio of the window, as reported by
    QWindow::devicePixelRatio(). In addition, it displays the native DPI and
    device pixel ratio of the screen the window is on, as reported by
    QPlatformScreen::logicalDpi() and QPlatformScreen::devicePixelRatio().

    The displayed values should be updated automatically on screen and DPI
    changes, and the dialog should maintain the same size. If not, it might be a
    Qt bug.

    DprGadget is a part of Qt's manual test suite, and you can find it at
    \c{qtbase/tests/manual/highdpi/dprgadget}.

    \section1 Environment Variable Reference

    This section lists high-DPI-related environment variables recognized by Qt.
    In alphabetical order:

\table
    \header
        \li Variable
        \li Description
    \row
        \li \c QT_ENABLE_HIGHDPI_SCALING
        \li Set to 0 to disable high-dpi scaling.
        \note This has no effect on platforms such as Wayland
        or macOS - it does not disable any native high-DPI support. This
        variable is intended for testing purposes only, and it is not
        recommended to set it on a permanent basis.
    \row
        \li \c QT_FONT_DPI
        \li Sets a global logical DPI. On embedded platforms without a native
        windowing system (such as EGLFS), this is the recommended way to
        configure scaling. On other platforms, avoid this variable and use the
        operating system's scaling settings instead.
    \row
        \li \c QT_SCALE_FACTOR
        \li Sets a global scale factor. For debugging and testing purposes.
    \row
        \li \c QT_SCALE_FACTOR_ROUNDING_POLICY
        \li Sets the scale factor
        \l{Qt::HighDpiScaleFactorRoundingPolicy}{rounding policy}, which is
        applied to the scale factor computed from screen DPI.

        Supported values:

        \list
            \li Round
            \li PassThrough (default)
        \endlist
    \row
        \li \c QT_SCREEN_SCALE_FACTORS
        \li Sets a list of screen scale factors. The list can be in either of
        these formats:

        \list
          \li A semicolon-separated list of screen scale factors ("1;1.5;2"),
          \li A semicolon-separated list of screen=factor entries
              ("screenA=1;screenB=1.5;screenC=2").
        \endlist

        Setting this environment variable is not recommended since it prevents
        Qt from using system DPI values.
    \row
        \li \c QT_USE_PHYSICAL_DPI
        \li Makes Qt use physical DPI instead of logical DPI. Using logical
        DPI is normally the best option; this environment variable can be set
        in cases where logical DPI is not available and the physical DPI is
        known to be correct.
\endtable

    \section1 Coordinate Systems Reference

    The following coordinate systems are used across Qt's APIs. Most application
    code operates in device-independent pixels; the other systems are primarily
    relevant for low-level graphics and platform integration:

    \table
      \header
        \li Coordinate System
        \li Description
      \row
        \li Device Independent Pixels
        \li This is Qt's main coordinate system. Window, widget,
            Quick item, event, and screen geometry are all in device-independent
            pixels. Typically, a device-independent pixel has a constant visual
            size across device types and screen densities. Though this is a
            generalization, the exact size depends on device configuration.
      \row
        \li Device Pixels
        \li This coordinate system is used for rasterization and low-level
            graphics tasks, for example, when using the OpenGL API. The device
            pixel coordinate system is often equivalent to the physical
            coordinate system of the display, but this is not guaranteed. For
            example, both macOS and Ubuntu may apply additional scaling,
            depending on display settings.
      \row
        \li Native Pixels
        \li This is the coordinate system used by the native API, such as Win32
            or Cocoa (macOS). Depending on the platform and screen
            configuration, native pixels may be equivalent to device-independent
            or device pixels.
    \endtable

*/
