Skip to content

Latest commit

 

History

History
93 lines (70 loc) · 3.54 KB

README_WINDOWS.md

File metadata and controls

93 lines (70 loc) · 3.54 KB
Raw

Windows port progress tracker

Island is currently able to compile and run natively on Windows 10 (64bit) systems. Hot-reloading works, too. It is enabled by default for Debug targets.

I've tested using Visual Studio 2019, with Visual Studio's CMake build tools installed.

Visual Studio 2019 hints

  • Open the Cmake file by selecting "Open Directory"
  • After generating the CMake cache (which should happen automatically once you open), you can configure build targets. Choose "Debug x64", or "Release x64".
  • Regenerate CMake cache
  • In the project view, select "CMake Targets" to see all cmake targets which are associated with the current project - this allows you to inspect the Island framework source code at the same time as your own source
  • Hit Build All (ctrl+shift+b)
  • Hit Run (F5)

Visual Studio 2019 hot-reloading hints

Once you've hit the 'run' button on visual studio and the debugger is attached, the visual studio interface disables the shortcuts for building, and compiling. This does, however, not mean that you can't compile and hot-reload your project anymore.

Here are a few steps to set you up for hot-reloading on Windows

  • Build your app using Visual Studio
  • Start your app the normal way from Visual Studio, so that the Debugger is attached
  • Start a "x64 Native Tools Command Prompt for VS 2019": You'll find this under 'Windows Start Button → Visual Studio 2019 Folder → "x64 Native Tools Command Prompt for VS 2019"
  • Navigate to the directory in which your app gets built (that's the folder in which you find the app's .exe file)
  • Enter 'ninja' in the command prompt - this will trigger a recompile and hot-reload, if any of your source files changed

Auto-Hot-Reloading on Save

If you prefer to use hot-reloading without manually triggering a build, you can use the powershell script found in scripts/hot-reload.ps1. Given a source folder path and a build folder path, it will trigger a build automatically anytime a .cpp or .h files changes in the source folder.

Note This script will only work form within an x64 Native Tools Command Prompt (see above for how to start one of these). Once you have started a Command prompt, start powershell by typing powershell, and then navigate to the source folder of your app.

From there, you can call the hot-reload powershell script. If your app is found at ${YOUR_ISLAND_BASE_DIR}\apps\examples\hello_triangle and you've just successfully navigated to this folder, this is what you would typically type to get the autoreload watcher running:

    ..\..\..\scripts\hot-reload.ps1 . .\out\build\x64-Debug\

This assumes that your build folder is at ${YOUR_ISLAND_BASE_DIR}\apps\examples\hello_triangle\out\build\x64-Debug\

Installation instructions

  • Install Vulkan SDK for Windows via LunarG https://vulkan.lunarg.com/
  • Set the environment variable VULKAN_SDK to the path where you installed the Vulkan SDK if this has not been set automatically.

Progress

  • All Examples are working now
  • Release x64 Target works
  • Debug x64 Target works
  • Loading modules as plugins (.dlls) works
  • File watcher ported to Windows
  • Shader-hot-reloading works
  • Hot-reloading for native code needs some thought
  • le_jobs needs porting - implementation should use Windows' own Fiber API
  • swapchain direct - needs porting for windows, provided driver allows direct rendering
  • image swapchain needs porting - we can't pipe to ffmpeg like we did on Linux - or can we?