glplatform.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2010 Fredrik Höglund <fredrik@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "effect/globals.h"
#include "openglcontext.h"
 
#include <QByteArray>
#include <QSet>
#include <memory>
 
namespace KWin
{
// forward declare method
void cleanupGL();
 
class Version;
 
enum class GLFeature {
    LooseBinding,
 
    PackInvert,
 
    TimerQuery,
};
 
enum Driver {
    Driver_R100, // Technically "Radeon"
    Driver_R200,
    Driver_R300C,
    Driver_R300G,
    Driver_R600C,
    Driver_R600G,
    Driver_Nouveau,
    Driver_Intel,
    Driver_NVidia,
    Driver_Catalyst,
    Driver_Swrast,
    Driver_Softpipe,
    Driver_Llvmpipe,
    Driver_VirtualBox,
    Driver_VMware,
    Driver_Qualcomm,
    Driver_RadeonSI,
    Driver_Virgl,
    Driver_Panfrost,
    Driver_Lima,
    Driver_VC4,
    Driver_V3D,
    Driver_Unknown,
};
 
// clang-format off
enum ChipClass {
    // Radeon
    R100          = 0,      // GL1.3         DX7                   2000
    R200,                   // GL1.4         DX8.1     SM 1.4      2001
    R300,                   // GL2.0         DX9       SM 2.0      2002
    R400,                   // GL2.0         DX9b      SM 2.0b     2004
    R500,                   // GL2.0         DX9c      SM 3.0      2005
    R600,                   // GL3.3         DX10      SM 4.0      2006
    R700,                   // GL3.3         DX10.1    SM 4.1      2008
    Evergreen,              // GL4.0  CL1.0  DX11      SM 5.0      2009
    NorthernIslands,        // GL4.0  CL1.1  DX11      SM 5.0      2010
    SouthernIslands,        // GL4.5  CL1.2  DX11.1    SM 5.1      2012
    SeaIslands,             // GL4.5  CL2.0  DX12      SM 6.0      2013
    VolcanicIslands,        // GL4.5  CL2.0  DX12      SM 6.0      2015
    ArcticIslands,          // GL4.5  CL2.0  DX12      SM 6.0      2016
    Vega,                   // GL4.6  CL2.0  DX12      SM 6.0      2017
    Navi,                   // GL4.6  CL2.0  DX12.1    SM 6.4      2019
    UnknownRadeon = 999,
 
    // NVIDIA
    NV10          = 1000,   // GL1.2         DX7                   1999
    NV20,                   // GL1.3         DX8       SM 1.1      2001
    NV30,                   // GL1.5         DX9a      SM 2.0      2003
    NV40,                   // GL2.1         DX9c      SM 3.0      2004
    G80,                    // GL3.3         DX10      SM 4.0      2006
    GF100,                  // GL4.1  CL1.1  DX11      SM 5.0      2010
    UnknownNVidia = 1999,
 
    // Intel
    I8XX          = 2000,   //       GL1.3         DX7                   2001
    I915,                   //       GL1.4/1.5     DX9/DX9c  SM 2.0      2004
    I965,                   //       GL2.0/2.1     DX9/DX10  SM 3.0/4.0  2006
    SandyBridge,            // Gen6  GL3.1  CL1.1  DX10.1    SM 4.0      2010
    IvyBridge,              // Gen7  GL4.0  CL1.1  DX11      SM 5.0      2012
    Haswell,                // Gen7  GL4.0  CL1.2  DX11.1    SM 5.0      2013
    BayTrail,               // Gen7  GL4.0  CL1.2  DX11.1    SM 5.0      2013
    Cherryview,             // Gen8  GL4.0  CL1.2  DX11.2    SM 5.0      2013
    Broadwell,              // Gen8  GL4.4  CL2.0  DX11.2    SM 5.0      2014
    ApolloLake,             // Gen9  GL4.6  CL3.0  DX12      SM 6.0      2016
    Skylake,                // Gen9  GL4.6  CL3.0  DX12      SM 6.0      2015
    GeminiLake,             // Gen9  GL4.6  CL3.0  DX12      SM 6.0      2017
    KabyLake,               // Gen9  GL4.6  CL3.0  DX12      SM 6.0      2017
    CoffeeLake,             // Gen9  GL4.6  CL3.0  DX12      SM 6.0      2018
    WhiskeyLake,            // Gen9  GL4.6  GL3.0  DX12      SM 6.0      2018
    CometLake,              // Gen9  GL4.6  GL3.0  DX12      SM 6.0      2019
    CannonLake,             // Gen10 GL4.6  GL3.0  DX12      SM 6.0      2018
    IceLake,                // Gen11 GL4.6  CL3.0  DX12.1    SM 6.0      2019
    TigerLake,              // Gen12 GL4.6  CL3.0  DX12.1    SM 6.0      2020
    UnknownIntel  = 2999,
 
    // Qualcomm Adreno
    // from https://en.wikipedia.org/wiki/Adreno
    Adreno1XX     = 3000,   // GLES1.1
    Adreno2XX,              // GLES2.0       DX9c
    Adreno3XX,              // GLES3.0 CL1.1 DX11.1
    Adreno4XX,              // GLES3.1 CL1.2 DX11.2
    Adreno5XX,              // GLES3.1 CL2.0 DX11.2
    UnknownAdreno = 3999,
 
    // Panfrost Mali
    // from https://docs.mesa3d.org/drivers/panfrost.html
    MaliT7XX      = 4000,   // GLES2.0/GLES3.0
    MaliT8XX,               // GLES3.0
    MaliGXX,                // GLES3.0
    UnknownPanfrost = 4999,
 
    // Lima Mali
    // from https://docs.mesa3d.org/drivers/lima.html
    Mali400       = 5000,
    Mali450,
    Mali470,
    UnknownLima = 5999,
 
    // Broadcom VideoCore IV (e.g. Raspberry Pi 0 to 3), GLES 2.0/2.1 with caveats
    VC4_2_1       = 6000, // Found in Raspberry Pi 3B+
    UnknownVideoCore4 = 6999,
 
    // Broadcom VideoCore 3D (e.g. Raspberry Pi 4, Raspberry Pi 400)
    V3D_4_2       = 7000, // Found in Raspberry Pi 400
    UnknownVideoCore3D = 7999,
 
    UnknownChipClass = 99999,
};
// clang-format on
 
class KWIN_EXPORT GLPlatform
{
public:
    ~GLPlatform();
 
    void detect(OpenGLPlatformInterface platformInterface);
 
    void printResults() const;
 
    static GLPlatform *instance();
 
    bool supports(GLFeature feature) const;
 
    Version glVersion() const;
 
    Version glslVersion() const;
 
    Version mesaVersion() const;
 
    Version driverVersion() const;
 
    Driver driver() const;
 
    ChipClass chipClass() const;
 
    bool isMesaDriver() const;
 
    bool isRadeon() const;
 
    bool isNvidia() const;
 
    bool isIntel() const;
 
    bool isVirtualBox() const;
 
    bool isVMware() const;
 
    bool isSoftwareEmulation() const;
 
    bool isVirtualMachine() const;
 
    bool isAdreno() const;
 
    bool isVirgl() const;
 
    bool isPanfrost() const;
 
    bool isLima() const;
 
    bool isVideoCore4() const;
 
    bool isVideoCore3D() const;
 
    QByteArrayView glVersionString() const;
    QByteArrayView glRendererString() const;
    QByteArrayView glVendorString() const;
    QByteArrayView glShadingLanguageVersionString() const;
    bool isLooseBinding() const;
    bool isGLES() const;
 
    CompositingType recommendedCompositor() const;
 
    bool preferBufferSubData() const;
 
    OpenGLPlatformInterface platformInterface() const;
 
    static QString driverToString(Driver driver);
    static QByteArray driverToString8(Driver driver);
 
    static QString chipClassToString(ChipClass chipClass);
    static QByteArray chipClassToString8(ChipClass chipClass);
 
private:
    GLPlatform();
    friend void KWin::cleanupGL();
    static void cleanup();
 
private:
    QByteArray m_glsl_version;
    QByteArrayView m_chipset;
    Driver m_driver;
    ChipClass m_chipClass;
    CompositingType m_recommendedCompositor;
    Version m_glslVersion;
    Version m_mesaVersion;
    Version m_driverVersion;
    bool m_looseBinding : 1;
    bool m_packInvert : 1;
    bool m_virtualMachine : 1;
    bool m_preferBufferSubData : 1;
    OpenGLPlatformInterface m_platformInterface;
    std::unique_ptr<OpenGlContext> m_context;
    static std::unique_ptr<GLPlatform> s_platform;
};
 
inline GLPlatform *GLPlatform::instance()
{
    if (!s_platform) {
        s_platform.reset(new GLPlatform());
    }
    return s_platform.get();
}
 
} // namespace KWin