OpenGL: Added option to control desired adapter type in OpenGL (close #450)

Author: MikhailGorobets

Graphics/GraphicsEngine/interface/GraphicsTypes.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3485,6 +3485,25 @@ struct EngineGLCreateInfo DILIGENT_DERIVE(EngineCreateInfo)
     /// Use IRenderDevice::GetDeviceInfo().NDC to get current NDC.
     Bool         ZeroToOneNDZ DEFAULT_INITIALIZER(false);
 
+    /// The GPU preference allows you to request either the integrated or dedicated GPU
+    /// on systems having both onboard and dedicated GPUs. Currently this works only on Windows and Linux.
+    ///
+    /// * On Windows this is done by setting the `NvOptimusEnablement` and `AmdPowerXpressRequestHighPerformance`.
+    ///   When the Nvidia and AMD drivers see their respective symbol exported and set to nonzero in a program,
+    ///   they will take precedence over the integrated GPU when creating the OpenGL context.
+    ///
+    ///   Unfortunately, there is no way to transfer exported symbols from static libraries
+    ///   to the executable file without explicitly creating a Module-Definition File (.def).
+    ///
+    ///   Therefore you need to explicitly define these variables in your executable file:
+    ///   https://gist.github.com/statico/6809850727c708f08458
+    ///   or you can use the `Diligent-GLAdapterSelector` object library as source input to your executable target:
+    ///   `target_sources(MyExecutable PRIVATE $<TARGET_OBJECTS:Diligent-GLAdapterSelector>)`,
+    ///   see https://cmake.org/cmake/help/v3.16/manual/cmake-buildsystem.7.html#object-libraries.
+    ///
+    /// * On Linux this affects the `DRI_PRIME` environment variable that is used by Mesa drivers that support PRIME.
+    ADAPTER_TYPE PreferredAdapterType DEFAULT_INITIALIZER(ADAPTER_TYPE_UNKNOWN);
+
 #if PLATFORM_EMSCRIPTEN
     /// WebGL context attributes.
     WebGLContextAttribs WebGLAttribs;

Graphics/GraphicsEngineOpenGL/CMakeLists.txt

@@ -281,8 +281,12 @@ else()
     )
 endif()
 
+add_library(Diligent-GLAdapterSelector OBJECT "src/GLAdapterSelector.cpp")
+target_link_libraries(Diligent-GLAdapterSelector PRIVATE Diligent-BuildSettings)
+
 set_common_target_properties(Diligent-GraphicsEngineOpenGL-shared)
 set_common_target_properties(Diligent-GraphicsEngineOpenGL-static)
+set_common_target_properties(Diligent-GLAdapterSelector)
 
 source_group("src" FILES ${SOURCE})
 if(PLATFORM_WIN32)
@@ -298,6 +302,9 @@ set_target_properties(Diligent-GraphicsEngineOpenGL-static PROPERTIES
 set_target_properties(Diligent-GraphicsEngineOpenGL-shared PROPERTIES
     FOLDER DiligentCore/Graphics
 )
+set_target_properties(Diligent-GLAdapterSelector PROPERTIES 
+    FOLDER DiligentCore/Graphics
+)
 
 set_source_files_properties(
     readme.md PROPERTIES HEADER_FILE_ONLY TRUE
@@ -306,4 +313,5 @@ set_source_files_properties(
 if(DILIGENT_INSTALL_CORE)
     install_core_lib(Diligent-GraphicsEngineOpenGL-shared)
     install_core_lib(Diligent-GraphicsEngineOpenGL-static)
+    install_core_lib(Diligent-GLAdapterSelector)
 endif()

Graphics/GraphicsEngineOpenGL/src/EngineFactoryOpenGL.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -137,6 +137,38 @@ static void SetDefaultGraphicsAdapterInfo(GraphicsAdapterInfo& AdapterInfo)
     AdapterInfo.Queues[0].TextureCopyGranularity[2] = 1;
 }
 
+static void SetPreferredAdapter(const EngineGLCreateInfo& EngineCI)
+{
+    bool EnableDedicatedGPU = EngineCI.PreferredAdapterType == ADAPTER_TYPE_DISCRETE;
+#if PLATFORM_WIN32
+    const HMODULE ModuleHandle                         = GetModuleHandle(nullptr);
+    Uint64* const NvOptimusEnablement                  = reinterpret_cast<Uint64*>(GetProcAddress(ModuleHandle, "NvOptimusEnablement"));
+    Uint64* const AmdPowerXpressRequestHighPerformance = reinterpret_cast<Uint64*>(GetProcAddress(ModuleHandle, "AmdPowerXpressRequestHighPerformance"));
+    if (!NvOptimusEnablement && !AmdPowerXpressRequestHighPerformance)
+    {
+        LOG_WARNING_MESSAGE("Neither NvOptimusEnablement nor AmdPowerXpressRequestHighPerformance symbols found. "
+                            "You need to explicitly define these variables in your executable file: "
+                            "https://gist.github.com/statico/6809850727c708f08458XpressRequestHighPerformance, "
+                            "or you can use the `Diligent-GLAdapterSelector` object library as source input to your executable target: "
+                            "`target_sources(MyExecutable PRIVATE $<TARGET_OBJECTS:Diligent-GLAdapterSelector>)`, "
+                            "see https://cmake.org/cmake/help/v3.16/manual/cmake-buildsystem.7.html#object-libraries).");
+    }
+    if (AmdPowerXpressRequestHighPerformance)
+    {
+        *AmdPowerXpressRequestHighPerformance = EnableDedicatedGPU;
+    }
+    if (NvOptimusEnablement)
+    {
+        *NvOptimusEnablement = EnableDedicatedGPU;
+    }
+#elif PLAtTFORM_LINUX
+    setenv("DRI_PRIME", EnableDedicatedGPU ? "1" : "0", 1);
+#else
+    if (EnableDedicatedGPU)
+        LOG_WARNING_MESSAGE("Setting preferred adapter type isn't supported on this platform");
+#endif
+}
+
 void EngineFactoryOpenGLImpl::EnumerateAdapters(Version              MinVersion,
                                                 Uint32&              NumAdapters,
                                                 GraphicsAdapterInfo* Adapters) const
@@ -205,6 +237,7 @@ void EngineFactoryOpenGLImpl::CreateDeviceAndSwapChainGL(const EngineGLCreateInf
         SetRawAllocator(EngineCI.pRawMemAllocator);
         auto& RawMemAllocator = GetRawAllocator();
 
+        SetPreferredAdapter(EngineCI);
         RenderDeviceGLImpl* pRenderDeviceOpenGL{
             NEW_RC_OBJ(RawMemAllocator, "TRenderDeviceGLImpl instance", TRenderDeviceGLImpl)(
                 RawMemAllocator, this, EngineCI, &SCDesc //
@@ -303,6 +336,7 @@ void EngineFactoryOpenGLImpl::AttachToActiveGLContext(const EngineGLCreateInfo&
         SetRawAllocator(EngineCI.pRawMemAllocator);
         auto& RawMemAllocator = GetRawAllocator();
 
+        SetPreferredAdapter(EngineCI);
         RenderDeviceGLImpl* pRenderDeviceOpenGL{
             NEW_RC_OBJ(RawMemAllocator, "TRenderDeviceGLImpl instance", TRenderDeviceGLImpl)(
                 RawMemAllocator, this, EngineCI //

Graphics/GraphicsEngineOpenGL/src/GLAdapterSelector.cpp

@@ -0,0 +1,45 @@
+/*
+ *  Copyright 2024 Diligent Graphics LLC
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *  In no event and under no legal theory, whether in tort (including negligence),
+ *  contract, or otherwise, unless required by applicable law (such as deliberate
+ *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
+ *  liable for any damages, including any direct, indirect, special, incidental,
+ *  or consequential damages of any character arising as a result of this License or
+ *  out of the use or inability to use the software (including but not limited to damages
+ *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and
+ *  all other commercial damages or losses), even if such Contributor has been advised
+ *  of the possibility of such damages.
+ */
+
+#include <cinttypes>
+
+#if PLATFORM_WIN32
+#    define DILIGENT_INTERFACE_EXPORT __declspec(dllexport)
+#elif PLATFORM_LINUX
+#    define DILIGENT_INTERFACE_EXPORT __attribute__((visibility("default")))
+#else
+#    define DILIGENT_INTERFACE_EXPORT
+#endif
+
+/// Let the NVIDIA and AMD know we want to use their graphics card on a dual graphics card system.
+extern "C"
+{
+    /// https://community.amd.com/thread/169965
+    DILIGENT_INTERFACE_EXPORT uint64_t AmdPowerXpressRequestHighPerformance = 0x0;
+
+    /// http://developer.download.nvidia.com/devzone/devcenter/gamegraphics/files/OptimusRenderingPolicies.pdf
+    DILIGENT_INTERFACE_EXPORT uint64_t NvOptimusEnablement = 0x0;
+}