Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

AtlasEngine: Make shader hot-reloads possible in Windows Terminal #12227

Merged
1 commit merged into from
Jan 24, 2022
Merged

AtlasEngine: Make shader hot-reloads possible in Windows Terminal #12227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions src/renderer/atlas/AtlasEngine.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@

#include "../../interactivity/win32/CustomWindowMessages.h"

#define SHADER_SOURCE_DIRECTORY LR"(..\..\renderer\atlas\)"

// #### NOTE ####
// This file should only contain methods that are only accessed by the caller of Present() (the "Renderer" class).
// Basically this file poses the "synchronization" point between the concurrently running
Expand Down Expand Up @@ -192,16 +190,17 @@ AtlasEngine::AtlasEngine()
_sr.isWindows10OrGreater = IsWindows10OrGreater();

#ifndef NDEBUG
// If you run the Host.EXE project inside Visual Studio it'll have a working directory of
// $(SolutionDir)\src\host\exe. This relative path will thus end up in this source directory.
_sr.sourceCodeWatcher = wil::make_folder_change_reader_nothrow(SHADER_SOURCE_DIRECTORY, false, wil::FolderChangeEvents::FileName | wil::FolderChangeEvents::LastWriteTime, [this](wil::FolderChangeEvent, PCWSTR path) {
if (til::ends_with(path, L".hlsl"))
{
auto expected = INT64_MAX;
const auto invalidationTime = std::chrono::steady_clock::now() + std::chrono::milliseconds(100);
_sr.sourceCodeInvalidationTime.compare_exchange_strong(expected, invalidationTime.time_since_epoch().count(), std::memory_order_relaxed);
}
});
{
_sr.sourceDirectory = std::filesystem::path{ __FILE__ }.parent_path();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How the devil does this work when the app is packaged and deployed? Does it just look for the hlsl's in the package?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

__FILE__ usually expands to the absolute path of the current source file (AtlasEngine.cpp). Sometimes with some compilers or toolchain setups this isn't the case, but it works for us at least. If I take the parent path of AtlasEngine.cpp I can get the absolute path to the /atlas/ source directory.

_sr.sourceCodeWatcher = wil::make_folder_change_reader_nothrow(_sr.sourceDirectory.c_str(), false, wil::FolderChangeEvents::FileName | wil::FolderChangeEvents::LastWriteTime, [this](wil::FolderChangeEvent, PCWSTR path) {
if (til::ends_with(path, L".hlsl"))
{
auto expected = INT64_MAX;
const auto invalidationTime = std::chrono::steady_clock::now() + std::chrono::milliseconds(100);
_sr.sourceCodeInvalidationTime.compare_exchange_strong(expected, invalidationTime.time_since_epoch().count(), std::memory_order_relaxed);
}
});
}
#endif
}

Expand Down Expand Up @@ -265,8 +264,8 @@ try

try
{
static const auto compile = [](const wchar_t* path, const char* target) {
const wil::unique_hfile fileHandle{ CreateFileW(path, GENERIC_READ, FILE_SHARE_READ, nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr) };
static const auto compile = [](const std::filesystem::path& path, const char* target) {
const wil::unique_hfile fileHandle{ CreateFileW(path.c_str(), GENERIC_READ, FILE_SHARE_READ, nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr) };
THROW_LAST_ERROR_IF(!fileHandle);

const auto fileSize = GetFileSize(fileHandle.get(), nullptr);
Expand Down Expand Up @@ -303,8 +302,8 @@ try
return blob;
};

const auto vs = compile(SHADER_SOURCE_DIRECTORY "shader_vs.hlsl", "vs_4_1");
const auto ps = compile(SHADER_SOURCE_DIRECTORY "shader_ps.hlsl", "ps_4_1");
const auto vs = compile(_sr.sourceDirectory / L"shader_vs.hlsl", "vs_4_1");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we're only setting _sr.sourceDirectory when ifndef NDEBUG, then what happens when we're in Release?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section of code is also guarded by a ifndef NDEBUG.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah okay I clearly missed that

const auto ps = compile(_sr.sourceDirectory / L"shader_ps.hlsl", "ps_4_1");

THROW_IF_FAILED(_r.device->CreateVertexShader(vs->GetBufferPointer(), vs->GetBufferSize(), nullptr, _r.vertexShader.put()));
THROW_IF_FAILED(_r.device->CreatePixelShader(ps->GetBufferPointer(), ps->GetBufferSize(), nullptr, _r.pixelShader.put()));
Expand Down
1 change: 1 addition & 0 deletions src/renderer/atlas/AtlasEngine.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,7 @@ namespace Microsoft::Console::Render
bool isWindows10OrGreater = true;

#ifndef NDEBUG
std::filesystem::path sourceDirectory;
wil::unique_folder_change_reader_nothrow sourceCodeWatcher;
std::atomic<int64_t> sourceCodeInvalidationTime{ INT64_MAX };
#endif
Expand Down
2 changes: 1 addition & 1 deletion src/renderer/atlas/pch.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#define WIN32_LEAN_AND_MEAN

#include <array>
#include <iomanip>
#include <filesystem>
#include <optional>
#include <sstream>
#include <string_view>
Expand Down