W S L Template Stacks

A WSL C++ Template Project for GLFW-Skia applications

View project on GitHub


1 Windows Setup Instruction

2.1 Requirements for Windows

   📚 Visual Studio 2022 Community Edition (optional)
   📚 Visual Studio code (optional)
   📚 Python 3
   📚 PowerShell

💫 New Setup wit VSC Agent See here


2.2 Built GLFW library (Windows):

GLFW Version 3.4 has a CMake file that generates Visual Studio projects, which can be built using Visual Studio 2022 Community Edition (VS2022) and the msbuild tool.

  • In your project folder create, if needed, a folder dependencies\win\
  • change to: dependencies\win\
  • Download glfw-3.4.zip in the folder dependencies\win\
  • for the next step use a reliable extraction tool that does not skip hidden or system files.
  • Extract the contents of glfw-3.4.zip into dependencies\win\glfw-3.4 so that the files are directly inside glfw-3.4 (not in a nested subfolder).
  • Check if the extraction did NOT happen in a sub folder like dependencies\win\glfw-3.4\glfw-3.4.
  • When the files are in dependencies\win\glfw-3.4\glfw-3.4 move the files and sub folders from dependencies\win\glfw-3.4\glfw-3.4. to: dependencies\win\glfw-3.4\.

2.2.1. dynamically(DLL) multithreaded libraries (preferred)

To Create the DLL release\debug use:

  • mkdir 'project root\dependencies\win\glfw-3.4\outdll if not yet available:
  • Change directory 'project root\dependencies\win\glfw-3.4\outdll
  • Run:
    cmake .. -G "Visual Studio 17 2022" -A x64 -DBUILD_SHARED_LIBS=ON
  • Than:
  • Before running msbuild, use PowerShell to search for msbuild.exe on the system. Use the full path found in the next command to build the solution
  • Then use the Full Path to msbuild.exe in the Next Command to execute it: & msbuild GLFW.sln /p:Configuration=Debug /p:Platform=x64
  • Copy the generated glfw3.dll file to the project root

This ensures VS2022 builds the Debug multithreaded DLL version in the ./outdll/src/Debug folder, or the Release multithreaded DLL version in the ./outdll/src/Release folder, depending on the selected Solution Configuration in Visual Studio. You can then copy the glfw3.dll file to your application executable folder to use it.

2.2.2 statical library use:

  • mkdir 'project root\dependencies\win\glfw-3.4\outstatic if not yet available:
  • Change directory 'project root\dependencies\win\glfw-3.4\outstatic
  • Run:
    cmake .. -G "Visual Studio 17 2022" -A x64 -DBUILD_SHARED_LIBS=OFF
  • Than run:
  • Before running msbuild, use PowerShell to search for msbuild.exe on the system. Use the full path found in the next command to build the solution
  • Then use the Full Path to msbuild.exe in the Next Command to execute it: msbuild GLFW.sln /p:Configuration=Debug /p:Platform=x64

This ensures VS2022 builds the Debug static multithreaded version in the ./outstatic/src/Debug folder, or the Release static multithreaded version in the ./outstatic/src/Release folder, again depending on the Solution Configuration. The filename is: glfw3.lib and will be linked into your application when you link against it

2.2.3 Update CMake files

After building the GLFW library (as DLL or static) Update the cmake/windows.cmake, function: n_SetExtraWindowsFolders()

  • Check/Set the include folder:${PROJECT_SOURCE_DIR}/dependencies/win/glfw-3.4/include (GLFW_WIN_INCLUDE_DIR)

  • Static linking
    • Make sure the path to the library folder (file with .lib) is added to: ${PROJECT_SOURCE_DIR}/dependencies/win/glfw-3.4/outstatic/src/debug (GLFW_WIN_LIB_DIR)
    • Make sure the variable GLFW_LIBS_WIN_LOCAL contains glfw3* the name of the .lib file (glfw3.lib) in the library folder
  • Dynamic linking
    • Make sure the path to the library folder (file with .lib) is added to ${PROJECT_SOURCE_DIR}/dependencies/win/glfw-3.4/outdll/src/debug (GLFW_WIN_LIB_DIR)
    • Make sure the variable GLFW_LIBS_WIN_LOCAL contains glfw3dll the name of the import library file (glfw3dll.lib) in the library folder
    • Make sure the .dll file is available in your application’s runtime folder.


2.3 Built Skia library

  1. First Build the depot_tools. depot_tools is a collection of scripts/tools used to manage large Google Git projects
    • In your project folder Navigate to the folder: .\dependencies\win or create it, if it does not exists,
    • Clone the git repository: git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git

      - This creates a folder: .\dependencies\win\depot_tools add this to the system path and reopen the CLI
      - Test. Execute: gclient help → should display help information.

2.3.1 Built dependency Ninja if needed

  • Execute ninja --version When this returns a version Ninja is already build and you skip this and continue with section 2.3.2 below.
  • If ninja is not installed Download it form here
  • Extract it in the project root under the subfolder: .\dependencies\win
  • Make sure to add the installed folder with ninja.exe to your system PATH and that ninja.exe is available in your terminal

⚠️ Ensure this path is defined before depot_tools in your PATH!
depot_tools includes a ninja.bat file that will break builds if used accidentally.
This maya also result into vague build issues

  • Test. Open a CLI and type: ninja --version

🤢Error?
python not found using: ninja --version
Because of course… Windows tries to run a fake python.exe from the Microsoft Store, instead of your real Python install.

✅ Fix
Rename the python.exe and python3.exe files in the following folder to .bak or something similar explorer "$env:LOCALAPPDATA\Microsoft\WindowsApps"

⚠️ Bonus round (when you’re extra unlucky — and you probably are): The file will be in use. Because why wouldn’t it be? Open a Power-shell in administrator mode and delete or rename the files.


2.3.2 Build Skia Debug

  • Check this: When you have build Skia before (especially if done in an , old,project folder: ./dependencies/win), check and remove the old System environment variables and paths, old system variables can impact the a new installation, so remove these:

    • Environment variable: EMSDK
    • Environment variable: EMSDK_NODE
    • Environment variable: EMSDK_PYTHON
    • Environment variable: JAVA_HOME only when points to a Skai subfolder
    • Environment Path: Remove the old paths to the Skia subfolders (usual at the top)
      📌Tip Use the following Powershell command to check the value of the variables: Get-ChildItem Env:EMSDK* ⚠️warning failing to do so may lead to nasty Skia build issues
  • In your project folder navigate to: .\dependencies\win
  • Clone Skia Execute command: git clone --recursive https://skia.googlesource.com/skia.git
  • Change cd to project root\dependencies\win\skia
  • Execute command: git checkout chrome/m126 # To checkout a stable build instead a the master branch (Use same as on Linux!)
  • The following command will call a the Skia build script which uses depot_tools to get the dependencies:
  • Execute command: python tools\git-sync-deps
    • Test: It should have created tools like gn and other dependencies, test type in the CLI:
      Execute command: .\bin\gn --version

⚠️ Warning
Check for errors like: file name too long...

If you see this, your Skia build will fail. This is one of the most common causes (together with 2.3.1) of strange or hard-to-diagnose build errors on Windows, especially with Skia or other large C++ projects.

✅ Solution:
You must shorten the folder path. Try the following:
C:\libs\skia

📌 Many developers abandon deeply nested folder structures altogether for Skia and similar projects due to this issue.

  • Make sure to be in the folder: project root\dependencies\win\skia
  • create folder: mkdir out\Debug
  • In the next steps we are going to Generate build files with GN (uses Ninja)
  • Execute this command in powershell CLI: 
    @"
is_debug = true
is_official_build = false
skia_use_gl = true
target_cpu = "x64"
skia_enable_fontmgr_empty = false
skia_use_angle = false
skia_use_icu = true
extra_cflags = ["/MDd", "/D_ITERATOR_DEBUG_LEVEL=2", "/GR"]
"@ | Out-File out\Debug\args.gn -Encoding ASCII
  • Execute in PowerShell CLI: .\bin\gn gen out\Debug
    This creates the debug build!

Alternative Manual generate build files

This give you the option to change arguments in a file that will be opened automatically, use this if you want to configure Skia manual

  • Make sure to be in the folder: project root\dependencies\win\skia
  • Execute: .\bin\gn args out\Debug
  • Paste the following into the editor that opens:

Editor opens past in this, and save & close the editor and gn will continue :
📌 Tip: use this command to display the valid options: gn args --list out/Debug 

is_debug = true
is_official_build = false
skia_use_gl = true
target_cpu = "x64"    
skia_enable_fontmgr_empty = false      # Optional: enable full font manager
skia_use_angle = false                 # Optional: disable ANGLE if using native OpenGL
skia_use_icu = true                    # ICU required for Unicode support

extra_cflags = [ "/MDd", "/D_ITERATOR_DEBUG_LEVEL=2", "/GR" ]             # Dynamic
#extra_cflags = [ "/MTd", "/D_ITERATOR_DEBUG_LEVEL=2" ]            # Static
#extra_ldflags = [ "/NODEFAULTLIB:LIBCMT", "/DEFAULTLIB:LIBCMTD" ] #

/# DON't add these deprecated\removed options they may cause build errrors
/# skia_enable_gpu = true               # IS Build ERROR!

  • Activate the MS VC environment, Check the path (command seems not needed?): & "C:\Program Files\Microsoft Visual Studio\2022\Professional\VC\Auxiliary\Build\vcvars64.bat ` DON’T USE vcvars64.bat gn can handled it self!
  • Make sure to be in the folder: project root\dependencies\win\skia
  • Build it: ninja -C out\Debug
Result should include:
- out\Debug\skia.lib         
- out\Debug\libskia.a
- out\Debug\obj\skia\*.obj
  • Update the ./cmake/windows.cmake file, make sure it contains:
    set(SKIA_WIN_CORE_INCLUDE "${PROJECT_SOURCE_DIR}/dependencies/win/skia")

⚠️ Don’t add the include folder! This folder is part of the include directive of the Skia files

  • Update the ./cmake/windows.cmake file, make sure it contains:
    set(SKIA_WIN_LIBS "${PROJECT_SOURCE_DIR}/dependencies/win/skia/out/Debug")
  • Ensure skiais added to the variable: SKIA_LIBS_LOCAL in cmake/windows.cmake


2.3.3 Build Skia Release

This will create the Skia release library

2.3.3.1 Install libjpeg-turbo

  • Navigate to: ./dependencies/win of the project root folder.
  • Download from here and build it
  • mkdir build and cd build
  • Configure: cmake .. -G "Visual Studio 17 2022" -A x64 -DCMAKE_BUILD_TYPE=Release
  • Build: cmake --build . --config Release
  • Add the include and library folders manually to the Skia release build config below.
  • Make sure you return to the subfolder l/dependencies/win/skia of the project root folder!

2.3.3.2 Generate build files for Skia Release

  • Navigate to: ./dependencies/win/skia of the project root folder.
  • create folder: mkdir out\Release
  • Execute command: in powershell CLI: 
    @"
is_debug = false
is_official_build = true
skia_use_gl = true
target_cpu = "x64"
skia_use_system_zlib = false
skia_use_system_harfbuzz = false
skia_use_system_libpng = false
skia_use_system_libwebp = false
skia_use_expat = false
skia_use_icu = false  # no international text layout, no BiDi!
extra_cflags = [
"/I../../../libjpeg-turbo/src",  ""/I../../../libjpeg-turbo/build""
]
"@ | Out-File out\Release\args.gn -Encoding ASCII

  • Execute: .\bin\gn gen out\Release This creates the Release build!

  • Make sure to be in the folder: project root\dependencies\win\skia
  • Build it: ninja -C out\Release


2.4 ⚠️ Common Pitfalls (Windows)

Setup your build environment in Windows is by definition more error sensitive then setting it up in Linux. Here a a few tips to help you avoid (build) issues:

  • 🚫 Avoid spaces or special characters in project paths
  • 🚫Make sure the official ninja.exe is first in PATH environment variable, not depot_tools\ninja.bat. failing to do so will generate builds errors during build of Skia
  • 🚫Make sure Skia is not to deep nested, to avoid errors related to long path names, building Skia
  • 🚫 Avoid spaces or special characters in project paths:
  • ✅ Use full paths in gn.exe avoid relative path
  • 🔄 Always reopen the terminal after changing the environment

Use the the build documentation to build the sample project

Home Sites

Code

Download .zip Download .tar.gz















Maintained by NicoJanE. Generated by GitHub Pages.