Skip to content

Asynchronous shader compilation #1209

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

Merged
merged 24 commits into from
Mar 8, 2023
Merged

Asynchronous shader compilation #1209

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
d7e1d16
Preliminary testing code.
Feb 24, 2023
143164a
Code for measuring render loop times.
Feb 24, 2023
6cad4f6
Fix test code.
Feb 24, 2023
8460274
Refactor experience.js.
Feb 28, 2023
38c273a
Preliminary code to separate out shader compilation from CreateProgram.
Feb 28, 2023
9257652
Force shader compilation in the test code.
Mar 1, 2023
1f04b1c
Make async code work + rename function.
Mar 1, 2023
ec25c68
Separate synchronous and asynchronous versions of CreateProgram.
Mar 2, 2023
f814deb
Assign the program handle on the Javascript thread.
Mar 3, 2023
77f5c19
Restore original experience.js.
Mar 3, 2023
1df96a2
Return both the program handle and VertexAttributeLocations from Crea…
Mar 4, 2023
209c34a
Throw a proper error after encountering an async shader compilation e…
Mar 6, 2023
d4401b7
Simplify error reporting.
Mar 6, 2023
678fb49
Preliminary code for movable ProgramData (not working yet).
Mar 7, 2023
5e66231
Use unique_ptr to make the Arcana return type work.
Mar 7, 2023
eb5a104
Initialize member variables in constructor.
Mar 8, 2023
f8c062d
Remove unnecessary release of unique_ptr.
Mar 8, 2023
089a278
Leave parameter of nulled operator anonymous.
Mar 8, 2023
e1872d5
Indent lambda captures.
Mar 8, 2023
2319953
Remove unused lambda capture.
Mar 8, 2023
654886c
Remove ProgramData.Disposed.
Mar 8, 2023
8f17fb7
Use pattern similar to CreateProgramAsync in CreateProgram.
Mar 8, 2023
4977f3e
Use BGFX_INVALID_HANDLE instead of bgfx::kInvalidHandle.
Mar 8, 2023
17666c0
Use brace initialization for BGFX handles.
Mar 8, 2023
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
47 changes: 25 additions & 22 deletions Plugins/NativeEngine/Source/NativeEngine.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,10 +686,12 @@ namespace Babylon
return vertexSource;
}

std::pair<bgfx::ProgramHandle,std::unordered_map<std::string,uint32_t>> NativeEngine::CreateProgramInternal(const std::string vertexSource, const std::string fragmentSource, ProgramData& program)
std::unique_ptr<ProgramData> NativeEngine::CreateProgramInternal(const std::string vertexSource, const std::string fragmentSource)
{
ShaderCompiler::BgfxShaderInfo shaderInfo = m_shaderCompiler.Compile(ProcessShaderCoordinates(vertexSource), ProcessSamplerFlip(fragmentSource));

std::unique_ptr<ProgramData> program = std::make_unique<ProgramData>();

static auto InitUniformInfos{
[](bgfx::ShaderHandle shader, const std::unordered_map<std::string, uint8_t>& uniformStages, std::unordered_map<uint16_t, UniformInfo>& uniformInfos, std::unordered_map<std::string, uint16_t>& uniformNameToIndex) {
auto numUniforms = bgfx::getShaderUniforms(shader);
Expand All @@ -709,12 +711,15 @@ namespace Babylon
}};

auto vertexShader = bgfx::createShader(bgfx::copy(shaderInfo.VertexBytes.data(), static_cast<uint32_t>(shaderInfo.VertexBytes.size())));
InitUniformInfos(vertexShader, shaderInfo.UniformStages, program.UniformInfos, program.UniformNameToIndex);
InitUniformInfos(vertexShader, shaderInfo.UniformStages, program->UniformInfos, program->UniformNameToIndex);

auto fragmentShader = bgfx::createShader(bgfx::copy(shaderInfo.FragmentBytes.data(), static_cast<uint32_t>(shaderInfo.FragmentBytes.size())));
InitUniformInfos(fragmentShader, shaderInfo.UniformStages, program.UniformInfos, program.UniformNameToIndex);
InitUniformInfos(fragmentShader, shaderInfo.UniformStages, program->UniformInfos, program->UniformNameToIndex);

program->Handle = bgfx::createProgram(vertexShader, fragmentShader, true);
program->VertexAttributeLocations = std::move(shaderInfo.VertexAttributeLocations);

return std::pair<bgfx::ProgramHandle, std::unordered_map<std::string, uint32_t>>{bgfx::createProgram(vertexShader, fragmentShader, true), std::move(shaderInfo.VertexAttributeLocations)};
return program;
}

Napi::Value NativeEngine::CreateProgram(const Napi::CallbackInfo& info)
Expand All @@ -724,9 +729,7 @@ namespace Babylon
ProgramData* program = new ProgramData{};
try
{
std::pair<bgfx::ProgramHandle, std::unordered_map<std::string, uint32_t>> programInfo = CreateProgramInternal(vertexSource, fragmentSource, *program);
program->Handle = programInfo.first;
program->VertexAttributeLocations = std::move(programInfo.second);
*program = std::move(*CreateProgramInternal(vertexSource, fragmentSource).release());
}
catch (const std::exception& ex)
{
Expand All @@ -742,34 +745,34 @@ namespace Babylon
const std::string fragmentSource = info[1].As<Napi::String>().Utf8Value();
const Napi::Function onSuccess = info[2].As<Napi::Function>();
const Napi::Function onError = info[3].As<Napi::Function>();

ProgramData* program = new ProgramData{};
Napi::Value jsProgram = Napi::Pointer<ProgramData>::Create(info.Env(), program, Napi::NapiPointerDeleter(program));

arcana::make_task(arcana::threadpool_scheduler, *m_cancellationSource,
[this, vertexSource, fragmentSource, program, cancellationSource{m_cancellationSource}]() -> std::pair<bgfx::ProgramHandle, std::unordered_map<std::string, uint32_t>>
[this, vertexSource, fragmentSource, program, cancellationSource{m_cancellationSource}]() -> std::unique_ptr<ProgramData>
{
return CreateProgramInternal(vertexSource, fragmentSource, *program);
return CreateProgramInternal(vertexSource, fragmentSource);
})
.then(m_runtimeScheduler, *m_cancellationSource, [program, onSuccessRef{Napi::Persistent(onSuccess)}, onErrorRef{Napi::Persistent(onError)}, cancellationSource{m_cancellationSource}](arcana::expected<std::pair<bgfx::ProgramHandle, std::unordered_map<std::string, uint32_t>>, std::exception_ptr> result)
.then(m_runtimeScheduler, *m_cancellationSource,
[program,
jsProgramRef{Napi::Persistent(jsProgram)},
onSuccessRef{Napi::Persistent(onSuccess)},
onErrorRef{Napi::Persistent(onError)},
cancellationSource{m_cancellationSource}](const arcana::expected<std::unique_ptr<ProgramData>, std::exception_ptr>& result)
{
if (result.has_error())
{
try
{
std::rethrow_exception(result.error());
}
catch (const std::exception& ex)
{
onErrorRef.Call({Napi::Error::New(onErrorRef.Env(), ex.what()).Value()});
}
onErrorRef.Call({Napi::Error::New(onErrorRef.Env(), result.error()).Value()});
}
else
{
std::pair<bgfx::ProgramHandle, std::unordered_map<std::string, uint32_t>> programInfo = result.value();
program->Handle = programInfo.first;
program->VertexAttributeLocations = std::move(programInfo.second);
*program = std::move(*result.value());
onSuccessRef.Call({});
}
});
return Napi::Pointer<ProgramData>::Create(info.Env(), program, Napi::NapiPointerDeleter(program));

return jsProgram;
}

Napi::Value NativeEngine::GetUniforms(const Napi::CallbackInfo& info)
Expand Down
21 changes: 18 additions & 3 deletions Plugins/NativeEngine/Source/NativeEngine.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,26 @@ namespace Babylon
struct ProgramData final
{
ProgramData() = default;
ProgramData(ProgramData&& other) = delete;
ProgramData(const ProgramData&) = delete;
ProgramData& operator=(ProgramData&& other) = delete;
ProgramData& operator=(const ProgramData& other) = delete;

ProgramData(ProgramData&& other) noexcept
{
(*this) = std::move(other);
}

ProgramData& operator=(ProgramData&& other) noexcept
{
Handle = std::move(other.Handle);
other.Handle = bgfx::ProgramHandle{bgfx::kInvalidHandle};
Disposed = std::move(other.Disposed);
Uniforms = std::move(other.Uniforms);
UniformNameToIndex = std::move(other.UniformNameToIndex);
UniformInfos = std::move(other.UniformInfos);
VertexAttributeLocations = std::move(other.VertexAttributeLocations);
return *this;
}

~ProgramData()
{
Dispose();
Expand Down Expand Up @@ -120,7 +135,7 @@ namespace Babylon
void DeleteVertexBuffer(NativeDataStream::Reader& data);
void RecordVertexBuffer(const Napi::CallbackInfo& info);
void UpdateDynamicVertexBuffer(const Napi::CallbackInfo& info);
std::pair<bgfx::ProgramHandle, std::unordered_map<std::string, uint32_t>> CreateProgramInternal(const std::string vertexSource, const std::string fragmentSource, ProgramData& program);
std::unique_ptr<ProgramData> CreateProgramInternal(const std::string vertexSource, const std::string fragmentSource);
Napi::Value CreateProgram(const Napi::CallbackInfo& info);
Napi::Value CreateProgramAsync(const Napi::CallbackInfo& info);
Napi::Value GetUniforms(const Napi::CallbackInfo& info);
Expand Down