magnum/src/Magnum/Platform/WindowlessWglApplication.cpp

/*
    This file is part of Magnum.

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
                2020, 2021, 2022, 2023 Vladimír Vondruš <mosra@centrum.cz>

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/

#include "WindowlessWglApplication.h"

#include <Corrade/Containers/StringView.h>
#include <Corrade/Utility/Assert.h>
#include <Corrade/Utility/Debug.h>

#include "Magnum/GL/Version.h"

#ifndef DOXYGEN_GENERATING_OUTPUT
/* Define stuff that we need because I can't be bothered with creating a new
   header just for a few defines */
#define WGL_CONTEXT_MAJOR_VERSION_ARB 0x2091
#define WGL_CONTEXT_MINOR_VERSION_ARB 0x2092
#define WGL_CONTEXT_FLAGS_ARB 0x2094
#define WGL_CONTEXT_PROFILE_MASK_ARB 0x9126
#define WGL_CONTEXT_CORE_PROFILE_BIT_ARB 0x00000001
#define WGL_CONTEXT_ES2_PROFILE_BIT_EXT 0x00000004

#ifndef WGL_ARB_create_context_no_error
#define WGL_CONTEXT_OPENGL_NO_ERROR_ARB 0x31B3
#endif
#endif

namespace Magnum { namespace Platform {

using namespace Containers::Literals;

WindowlessWglContext::WindowlessWglContext(const Configuration& configuration, GLContext* const magnumContext) {
    /* Register the window class (if not yet done) */
    WNDCLASSW wc;
    if(!GetClassInfoW(GetModuleHandleW(nullptr), L"Magnum Windowless Application", &wc)) {
        wc = WNDCLASSW{
            0,
            DefWindowProcW,
            0,
            0,
            GetModuleHandleW(nullptr),
            nullptr,
            nullptr,
            HBRUSH(COLOR_BACKGROUND),
            nullptr,
            L"Magnum Windowless Application"
        };

        if(!RegisterClassW(&wc)) {
            Error() << "Platform::WindowlessWglContext: cannot create window class:" << GetLastError();
            return;
        }
    }

    /* Create the window */
    _window = CreateWindowW(wc.lpszClassName, L"Magnum Windowless Application",
        WS_OVERLAPPEDWINDOW, 0, 0, 32, 32, 0, 0, wc.hInstance, 0);

    /* Get device context from the newly created window and save the previous
       one. In case the previous one is null, wglMakeCurrent(null, ...) would
       fail and thus we need to pass at least something there. As a commenter
       on https://github.com/glfw/glfw/issues/245#issuecomment-43475120 said:
       the Windows API is horrible. HORRIBLE. */
    HDC currentDeviceContext = wglGetCurrentDC();
    _deviceContext = GetDC(_window);
    if(!currentDeviceContext) currentDeviceContext = _deviceContext;

    /* Use first provided pixel format  */
    constexpr static const PIXELFORMATDESCRIPTOR pfd = {
        sizeof(PIXELFORMATDESCRIPTOR),
        1,
        /* Double-buffered with OpenGL support */
        PFD_DRAW_TO_WINDOW|PFD_SUPPORT_OPENGL|PFD_DOUBLEBUFFER,
        PFD_TYPE_RGBA,          /* RGBA */
        32,                     /* 32 bit */
        0, 0, 0, 0, 0, 0,
        0,
        0,
        0,
        0, 0, 0, 0,
        24,                     /* 24-bit depth buffer */
        8,                      /* 8-bit stencil buffer */
        0,
        PFD_MAIN_PLANE,
        0,
        0, 0, 0
    };
    const int pixelFormat = ChoosePixelFormat(_deviceContext, &pfd);
    SetPixelFormat(_deviceContext, pixelFormat, &pfd);

    /* Create temporary context so we are able to get the pointer to
       wglCreateContextAttribsARB(). To avoid messing up the app state we need
       to save the old active context and then restore it later. */
    const HGLRC currentContext = wglGetCurrentContext();
    const HGLRC temporaryContext = wglCreateContext(_deviceContext);
    if(!wglMakeCurrent(_deviceContext, temporaryContext)) {
        Error() << "Platform::WindowlessWglContext: cannot make temporary context current:" << GetLastError();
        wglDeleteContext(temporaryContext);
        return;
    }

    /* Get pointer to proper context creation function */
    typedef HGLRC(WINAPI*PFNWGLCREATECONTEXTATTRIBSARBPROC)(HDC, HGLRC, const int*);
    const PFNWGLCREATECONTEXTATTRIBSARBPROC wglCreateContextAttribsARB = reinterpret_cast<PFNWGLCREATECONTEXTATTRIBSARBPROC>( wglGetProcAddress(reinterpret_cast<LPCSTR>("wglCreateContextAttribsARB")));

    /* Request debug context if GpuValidation is enabled either via the
       configuration or via command-line */
    Configuration::Flags flags = configuration.flags();
    if((flags & Configuration::Flag::GpuValidation) || (magnumContext && magnumContext->configurationFlags() & GL::Context::Configuration::Flag::GpuValidation))
        flags |= Configuration::Flag::Debug;
    else if((flags & Configuration::Flag::GpuValidationNoError) || (magnumContext && magnumContext->configurationFlags() & GL::Context::Configuration::Flag::GpuValidationNoError))
        flags |= Configuration::Flag::NoError;

    /** @todo needs a growable DynamicArray with disabled alloc or somesuch */
    /* Optimistically choose core context first */
    GLint contextAttributes[11] = {
        #ifdef MAGNUM_TARGET_GLES
        #ifdef MAGNUM_TARGET_GLES2
        WGL_CONTEXT_MAJOR_VERSION_ARB, 2,
        #else
        WGL_CONTEXT_MAJOR_VERSION_ARB, 3,
        #endif
        WGL_CONTEXT_MINOR_VERSION_ARB, 0,
        WGL_CONTEXT_PROFILE_MASK_ARB, WGL_CONTEXT_ES2_PROFILE_BIT_EXT,
        /* Mask out the upper 32bits used for other flags */
        WGL_CONTEXT_FLAGS_ARB, GLint(UnsignedLong(flags) & 0xffffffffu),
        #else
        WGL_CONTEXT_MAJOR_VERSION_ARB, 3,
        WGL_CONTEXT_MINOR_VERSION_ARB, 1,
        WGL_CONTEXT_PROFILE_MASK_ARB, WGL_CONTEXT_CORE_PROFILE_BIT_ARB,
        /* Mask out the upper 32bits used for other flags */
        WGL_CONTEXT_FLAGS_ARB, GLint(UnsignedLong(flags) & 0xffffffffu),
        #endif

        /* The rest is added optionally */
        0, 0, /* WGL_CONTEXT_OPENGL_NO_ERROR_ARB */
        0
    };

    std::size_t nextAttribute = 8;
    CORRADE_INTERNAL_ASSERT(!contextAttributes[nextAttribute]);

    if(flags & Configuration::Flag::NoError) {
        contextAttributes[nextAttribute++] = WGL_CONTEXT_OPENGL_NO_ERROR_ARB;
        contextAttributes[nextAttribute++] = true;
    }

    CORRADE_INTERNAL_ASSERT(nextAttribute < Containers::arraySize(contextAttributes));

    _context = wglCreateContextAttribsARB(_deviceContext, configuration.sharedContext(), contextAttributes);

    #ifndef MAGNUM_TARGET_GLES
    /* Fall back to (forward compatible) GL 2.1 if core context creation fails */
    if(!_context) {
        Warning() << "Platform::WindowlessWglContext: cannot create core context, falling back to compatibility context:" << GetLastError();

        /** @todo duplicated three times, do better */
        GLint fallbackContextAttributes[5] = {
            /** @todo or keep the fwcompat? */
            /* Mask out the upper 32bits used for other flags */
            WGL_CONTEXT_FLAGS_ARB, GLint(UnsignedLong(flags & ~Configuration::Flag::ForwardCompatible) & 0xffffffffu),

            /* The rest is added dynamically */
            0, 0, /* WGL_CONTEXT_OPENGL_NO_ERROR_ARB */
            0
        };
        std::size_t nextFallbackAttribute = 2;
        CORRADE_INTERNAL_ASSERT(!fallbackContextAttributes[nextFallbackAttribute]);

        if(flags & Configuration::Flag::NoError) {
            fallbackContextAttributes[nextFallbackAttribute++] = WGL_CONTEXT_OPENGL_NO_ERROR_ARB;
            fallbackContextAttributes[nextFallbackAttribute++] = true;
        }

        CORRADE_INTERNAL_ASSERT(nextFallbackAttribute < Containers::arraySize(fallbackContextAttributes));

        _context = wglCreateContextAttribsARB(_deviceContext, configuration.sharedContext(), fallbackContextAttributes);

    /* Fall back to (forward compatible) GL 2.1 if we are on binary
       NVidia/AMD/Intel drivers on Windows. Instead of creating forward-compatible
       context with highest available version, they force the version to the
       one specified, which is completely useless behavior. */
    } else {
        /* We need to make the context current to read out vendor string */
        if(!wglMakeCurrent(_deviceContext, _context)) {
            Error() << "Platform::WindowlessWglContext: cannot make context current:" << GetLastError();

            /* Everything failed, at least try to delete the dangling contexts
               and revert to the previous context to regain some sanity */
            wglMakeCurrent(_deviceContext, currentContext);
            wglDeleteContext(temporaryContext);
            return;
        }

        /* The workaround check is the last so it doesn't appear in workaround
           list on unrelated drivers */
        const Containers::StringView vendorString = reinterpret_cast<const char*>(glGetString(GL_VENDOR));
        if((vendorString == "NVIDIA Corporation"_s ||
            vendorString == "Intel"_s ||
            vendorString == "ATI Technologies Inc."_s)
           && (!magnumContext || !magnumContext->isDriverWorkaroundDisabled("no-forward-compatible-core-context"_s)))
        {
            /* Destroy the core context and create a compatibility one */
            wglDeleteContext(_context);

            /** @todo duplicated three times, do better */
            GLint fallbackContextAttributes[5] = {
                /** @todo or keep the fwcompat? */
                /* Mask out the upper 32bits used for other flags */
                WGL_CONTEXT_FLAGS_ARB, GLint(UnsignedLong(flags & ~Configuration::Flag::ForwardCompatible) & 0xffffffffu),

                /* The rest is added dynamically */
                0, 0, /* WGL_CONTEXT_OPENGL_NO_ERROR_ARB */
                0
            };
            std::size_t nextFallbackAttribute = 2;
            CORRADE_INTERNAL_ASSERT(!fallbackContextAttributes[nextFallbackAttribute]);

            if(flags & Configuration::Flag::NoError) {
                fallbackContextAttributes[nextFallbackAttribute++] = WGL_CONTEXT_OPENGL_NO_ERROR_ARB;
                fallbackContextAttributes[nextFallbackAttribute++] = true;
            }

            CORRADE_INTERNAL_ASSERT(nextFallbackAttribute < Containers::arraySize(fallbackContextAttributes));

            _context = wglCreateContextAttribsARB(_deviceContext, configuration.sharedContext(), fallbackContextAttributes);
        }
    }
    #endif

    /* Make the previous context active and delete the temporary context */
    if(!wglMakeCurrent(currentDeviceContext, currentContext)) {
        Error() << "Platform::WindowlessWglContext: cannot make the previous context current:" << GetLastError();

        /* Everything is fucked up, but try to delete the temporary context
           anyway */
        wglDeleteContext(temporaryContext);
        return;
    }
    wglDeleteContext(temporaryContext);

    if(!_context)
        Error() << "Platform::WindowlessWglContext: cannot create context:" << GetLastError();
}

WindowlessWglContext::WindowlessWglContext(WindowlessWglContext&& other) noexcept: _window{other._window}, _deviceContext{other._deviceContext}, _context{other._context} {
    other._window = {};
    other._deviceContext = {};
    other._context = {};
}

WindowlessWglContext::~WindowlessWglContext() {
    if(_context) wglDeleteContext(_context);
    if(_window) DestroyWindow(_window);
}

WindowlessWglContext& WindowlessWglContext::operator=(WindowlessWglContext&& other) noexcept {
    using Utility::swap;
    swap(other._window, _window);
    swap(other._deviceContext, _deviceContext);
    swap(other._context, _context);
    return *this;
}

bool WindowlessWglContext::makeCurrent() {
    if(wglMakeCurrent(_deviceContext, _context))
        return true;

    Error() << "Platform::WindowlessWglContext::makeCurrent(): cannot make context current:" << GetLastError();
    return false;
}

bool WindowlessWglContext::release() {
    if(wglMakeCurrent(_deviceContext, nullptr))
        return true;

    Error() << "Platform::WindowlessWglContext::release(): cannot release current context:" << GetLastError();
    return false;
}

WindowlessWglContext::Configuration::Configuration() {
    GL::Context::Configuration::addFlags(GL::Context::Configuration::Flag::Windowless);
    #ifndef MAGNUM_TARGET_GLES
    addFlags(Flag::ForwardCompatible);
    #endif
}

WindowlessWglApplication::WindowlessWglApplication(const Arguments& arguments, const Configuration& configuration): WindowlessWglApplication{arguments, NoCreate} {
    createContext(configuration);
}

WindowlessWglApplication::WindowlessWglApplication(const Arguments& arguments, NoCreateT): _glContext{NoCreate}, _context{NoCreate, arguments.argc, arguments.argv} {}

void WindowlessWglApplication::createContext() { createContext({}); }

void WindowlessWglApplication::createContext(const Configuration& configuration) {
    if(!tryCreateContext(configuration)) std::exit(1);
}

bool WindowlessWglApplication::tryCreateContext(const Configuration& configuration) {
    CORRADE_ASSERT(_context.version() == GL::Version::None, "Platform::WindowlessWglApplication::tryCreateContext(): context already created", false);

    WindowlessWglContext glContext{configuration, &_context};
    if(!glContext.isCreated() || !glContext.makeCurrent() || !_context.tryCreate(configuration))
        return false;

    _glContext = Utility::move(glContext);
    return true;
}

WindowlessWglApplication::~WindowlessWglApplication() = default;

}}