juce_Displays.h

Go to the documentation of this file.

 /*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  Displays
{
private:
    Displays (Desktop&);
 
public:
    //==============================================================================
    struct JUCE_API  Display
    {
        bool isMain;
 
        Rectangle<int> totalArea;
 
        Rectangle<int> userArea;
 
        BorderSize<int> safeAreaInsets;
 
        BorderSize<int> keyboardInsets;
 
        Point<int> topLeftPhysical;
 
        double scale;
 
        double dpi;
 
        std::optional<double> verticalFrequencyHz;
    };
 
    //==============================================================================
    Rectangle<int> physicalToLogical (Rectangle<int> physicalRect,
                                      const Display* useScaleFactorOfDisplay = nullptr) const noexcept;
 
    Rectangle<float> physicalToLogical (Rectangle<float> physicalRect,
                                        const Display* useScaleFactorOfDisplay = nullptr) const noexcept;
 
    Rectangle<int> logicalToPhysical (Rectangle<int> logicalRect,
                                      const Display* useScaleFactorOfDisplay = nullptr) const noexcept;
 
    Rectangle<float> logicalToPhysical (Rectangle<float> logicalRect,
                                        const Display* useScaleFactorOfDisplay = nullptr) const noexcept;
 
    template <typename ValueType>
    Point<ValueType> physicalToLogical (Point<ValueType> physicalPoint,
                                        const Display* useScaleFactorOfDisplay = nullptr) const noexcept;
 
    template <typename ValueType>
    Point<ValueType> logicalToPhysical (Point<ValueType> logicalPoint,
                                        const Display* useScaleFactorOfDisplay = nullptr) const noexcept;
 
    const Display* getDisplayForRect (Rectangle<int> rect, bool isPhysical = false) const noexcept;
 
    const Display* getDisplayForPoint (Point<int> point, bool isPhysical = false) const noexcept;
 
    const Display* getPrimaryDisplay() const noexcept;
 
    RectangleList<int> getRectangleList (bool userAreasOnly) const;
 
    Rectangle<int> getTotalBounds (bool userAreasOnly) const;
 
    Array<Display> displays;
 
   #ifndef DOXYGEN
    void refresh();
 
    [[deprecated ("Use the getDisplayForPoint or getDisplayForRect methods instead "
                 "as they can deal with converting between logical and physical pixels.")]]
    const Display& getDisplayContaining (Point<int> position) const noexcept;
 
    // These methods have been deprecated - use the methods which return a Display* instead as they will return
    // nullptr on headless systems with no connected displays
    [[deprecated]] const Display& findDisplayForRect (Rectangle<int>, bool isPhysical = false) const noexcept;
    [[deprecated]] const Display& findDisplayForPoint (Point<int>, bool isPhysical = false) const noexcept;
    [[deprecated]] const Display& getMainDisplay() const noexcept;
   #endif
 
private:
    friend class Desktop;
 
    void init (Desktop&);
    void findDisplays (float masterScale);
 
    void updateToLogical();
 
    Display emptyDisplay;
};
 
} // namespace juce