vcl/skia/x11/gdiimpl.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * Some of this code is based on Skia source code, covered by the following
  10  * license notice (see readlicense_oo for the full license):
  11  *
  12  * Copyright 2016 Google Inc.
  13  *
  14  * Use of this source code is governed by a BSD-style license that can be
  15  * found in the LICENSE file.
  16  *
  17  */
  18
  19 #include <skia/x11/gdiimpl.hxx>
  20
  21 #include <tools/sk_app/unix/WindowContextFactory_unix.h>
  22
  23 #include <skia/utils.hxx>
  24 #include <skia/zone.hxx>
  25
  26 #include <X11/Xutil.h>
  27
  28 using namespace SkiaHelper;
  29
  30 X11SkiaSalGraphicsImpl::X11SkiaSalGraphicsImpl(X11SalGraphics& rParent)
  31     : SkiaSalGraphicsImpl(rParent, rParent.GetGeometryProvider())
  32     , mX11Parent(rParent)
  33 {
  34 }
  35
  36 void X11SkiaSalGraphicsImpl::Init()
  37 {
  38     // The m_pFrame and m_pVDev pointers are updated late in X11
  39     setProvider(mX11Parent.GetGeometryProvider());
  40     SkiaSalGraphicsImpl::Init();
  41 }
  42
  43 void X11SkiaSalGraphicsImpl::createWindowSurfaceInternal(bool forceRaster)
  44 {
  45     assert(!mWindowContext);
  46     assert(!mSurface);
  47     assert(mX11Parent.GetDrawable() != None);
  48     RenderMethod renderMethod = forceRaster ? RenderRaster : renderMethodToUse();
  49     mScaling = getWindowScaling();
  50     mWindowContext = createWindowContext(mX11Parent.GetXDisplay(), mX11Parent.GetDrawable(),
  51                                          &mX11Parent.GetVisual(), GetWidth() * mScaling,
  52                                          GetHeight() * mScaling, renderMethod, false);
  53     if (mWindowContext)
  54     {
  55         // See flushSurfaceToWindowContext().
  56         if (renderMethod == RenderRaster)
  57             mSurface = mWindowContext->getBackbufferSurface();
  58         else
  59             mSurface = createSkSurface(GetWidth(), GetHeight());
  60     }
  61 }
  62
  63 std::unique_ptr<sk_app::WindowContext>
  64 X11SkiaSalGraphicsImpl::createWindowContext(Display* display, Drawable drawable,
  65                                             const XVisualInfo* visual, int width, int height,
  66                                             RenderMethod renderMethod, bool temporary)
  67 {
  68     SkiaZone zone;
  69     sk_app::DisplayParams displayParams;
  70     displayParams.fColorType = kN32_SkColorType;
  71 #if defined LINUX
  72     // WORKAROUND: VSync causes freezes that can even temporarily freeze the entire desktop.
  73     // This happens even with the latest 450.66 drivers despite them claiming a fix for vsync.
  74     // https://forums.developer.nvidia.com/t/hangs-freezes-when-vulkan-v-sync-vk-present-mode-fifo-khr-is-enabled/67751
  75     if (getVendor() == DriverBlocklist::VendorNVIDIA)
  76         displayParams.fDisableVsync = true;
  77 #endif
  78     sk_app::window_context_factory::XlibWindowInfo winInfo;
  79     assert(display);
  80     winInfo.fDisplay = display;
  81     winInfo.fWindow = drawable;
  82     winInfo.fFBConfig = nullptr; // not used
  83     winInfo.fVisualInfo = const_cast<XVisualInfo*>(visual);
  84     assert(winInfo.fVisualInfo->visual != nullptr); // make sure it's not an uninitialized SalVisual
  85     winInfo.fWidth = width;
  86     winInfo.fHeight = height;
  87 #if defined DBG_UTIL && !defined NDEBUG
  88     // Our patched Skia has VulkanWindowContext that shares grDirectContext, which requires
  89     // that the X11 visual is always the same. Ensure it is so.
  90     static VisualID checkVisualID = -1U;
  91     // Exception is for the temporary case during startup, when SkiaHelper's
  92     // checkDeviceDenylisted() needs a WindowContext and may be called before SalVisual
  93     // is ready.
  94     if (!temporary)
  95     {
  96         assert(checkVisualID == -1U || winInfo.fVisualInfo->visualid == checkVisualID);
  97         checkVisualID = winInfo.fVisualInfo->visualid;
  98     }
  99 #else
 100     (void)temporary;
 101 #endif
 102     switch (renderMethod)
 103     {
 104         case RenderRaster:
 105             // Make sure we ask for color type that matches the X11 visual. If red mask
 106             // is larger value than blue mask, then on little endian this means blue is first.
 107             // This should also preferably match SK_R32_SHIFT set in config_skia.h, as that
 108             // improves performance, the common setup seems to be BGRA (possibly because of
 109             // choosing OpenGL-capable visual).
 110             displayParams.fColorType
 111                 = (visual->red_mask > visual->blue_mask ? kBGRA_8888_SkColorType
 112                                                         : kRGBA_8888_SkColorType);
 113             return sk_app::window_context_factory::MakeRasterForXlib(winInfo, displayParams);
 114         case RenderVulkan:
 115             return sk_app::window_context_factory::MakeVulkanForXlib(winInfo, displayParams);
 116         case RenderMetal:
 117             abort();
 118             break;
 119     }
 120     abort();
 121 }
 122
 123 bool X11SkiaSalGraphicsImpl::avoidRecreateByResize() const
 124 {
 125     if (SkiaSalGraphicsImpl::avoidRecreateByResize())
 126         return true;
 127     if (!mSurface || isOffscreen())
 128         return false;
 129     // Skia's WindowContext uses actual dimensions of the X window, which due to X11 being
 130     // asynchronous may be temporarily different from what VCL thinks are the dimensions.
 131     // That can lead to us repeatedly calling recreateSurface() because of "incorrect"
 132     // size, and we otherwise need to check for size changes, because VCL does not inform us.
 133     // Avoid the problem here by checking the size of the X window and bail out if Skia
 134     // would just return the same size as it is now.
 135     Window r;
 136     int x, y;
 137     unsigned int w, h, border, depth;
 138     XGetGeometry(mX11Parent.GetXDisplay(), mX11Parent.GetDrawable(), &r, &x, &y, &w, &h, &border,
 139                  &depth);
 140     return mSurface->width() == int(w) && mSurface->height() == int(h);
 141 }
 142
 143 void X11SkiaSalGraphicsImpl::freeResources() {}
 144
 145 void X11SkiaSalGraphicsImpl::Flush() { performFlush(); }
 146
 147 std::unique_ptr<sk_app::WindowContext> createVulkanWindowContext(bool temporary)
 148 {
 149     SalDisplay* salDisplay = vcl_sal::getSalDisplay(GetGenericUnixSalData());
 150     const XVisualInfo* visual;
 151     XVisualInfo* visuals = nullptr;
 152     if (!temporary)
 153         visual = &salDisplay->GetVisual(salDisplay->GetDefaultXScreen());
 154     else
 155     {
 156         // SalVisual from salDisplay may not be setup yet at this point, get
 157         // info for the default visual.
 158         XVisualInfo search;
 159         search.visualid = XVisualIDFromVisual(
 160             DefaultVisual(salDisplay->GetDisplay(), salDisplay->GetDefaultXScreen().getXScreen()));
 161         int count;
 162         visuals = XGetVisualInfo(salDisplay->GetDisplay(), VisualIDMask, &search, &count);
 163         assert(count == 1);
 164         visual = visuals;
 165     }
 166     std::unique_ptr<sk_app::WindowContext> ret = X11SkiaSalGraphicsImpl::createWindowContext(
 167         salDisplay->GetDisplay(), None, visual, 1, 1, RenderVulkan, temporary);
 168     if (temporary)
 169         XFree(visuals);
 170     return ret;
 171 }
 172
 173 void X11SkiaSalGraphicsImpl::prepareSkia() { SkiaHelper::prepareSkia(createVulkanWindowContext); }
 174
 175 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */