Skip to content

Add --screenshot option to all D3D12 examples #151

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

Open
loosche wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add --screenshot option to all D3D12 examples #151

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
106 changes: 106 additions & 0 deletions projects/common/dx_renderer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#include "dx_renderer.h"
#include "bitmap.h"

bool IsCompressed(DXGI_FORMAT fmt);
bool IsVideo(DXGI_FORMAT fmt);
Expand Down Expand Up @@ -1077,6 +1078,111 @@ HRESULT CreateTexture(
return S_OK;
}

bool SaveDxTextureAsPNG(DxRenderer* pRenderer, ID3D12Resource* pTexture, const std::filesystem::path& absPath)
{
D3D12_RESOURCE_DESC texDesc = pTexture->GetDesc();
const uint32_t width = static_cast<uint32_t>(texDesc.Width);
const uint32_t height = static_cast<uint32_t>(texDesc.Height);

// Get copyable footprint to determine the GPU-aligned row pitch
D3D12_PLACED_SUBRESOURCE_FOOTPRINT footprint = {};
UINT64 totalBytes = 0;
pRenderer->Device->GetCopyableFootprints(&texDesc, 0, 1, 0, &footprint, nullptr, nullptr, &totalBytes);

// Create CPU-readable readback buffer
ComPtr<ID3D12Resource> readbackBuffer;
HRESULT hr = CreateBuffer(pRenderer, static_cast<size_t>(totalBytes), D3D12_HEAP_TYPE_READBACK, &readbackBuffer);
if (FAILED(hr))
{
GREX_LOG_ERROR("SaveDxTextureAsPNG: failed to create readback buffer");
return false;
}

// Create a temporary command allocator and command list
ComPtr<ID3D12CommandAllocator> cmdAlloc;
ComPtr<ID3D12GraphicsCommandList> cmdList;
hr = pRenderer->Device->CreateCommandAllocator(D3D12_COMMAND_LIST_TYPE_DIRECT, IID_PPV_ARGS(&cmdAlloc));
if (FAILED(hr))
{
GREX_LOG_ERROR("SaveDxTextureAsPNG: failed to create command allocator");
return false;
}
hr = pRenderer->Device->CreateCommandList(0, D3D12_COMMAND_LIST_TYPE_DIRECT, cmdAlloc.Get(), nullptr, IID_PPV_ARGS(&cmdList));
if (FAILED(hr))
{
GREX_LOG_ERROR("SaveDxTextureAsPNG: failed to create command list");
return false;
}

// Transition: PRESENT -> COPY_SOURCE
D3D12_RESOURCE_BARRIER barrierToCopy = {};
barrierToCopy.Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION;
barrierToCopy.Transition.pResource = pTexture;
barrierToCopy.Transition.Subresource = D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES;
barrierToCopy.Transition.StateBefore = D3D12_RESOURCE_STATE_PRESENT;
barrierToCopy.Transition.StateAfter = D3D12_RESOURCE_STATE_COPY_SOURCE;
cmdList->ResourceBarrier(1, &barrierToCopy);

// Copy texture to readback buffer
D3D12_TEXTURE_COPY_LOCATION dst = {};
dst.pResource = readbackBuffer.Get();
dst.Type = D3D12_TEXTURE_COPY_TYPE_PLACED_FOOTPRINT;
dst.PlacedFootprint = footprint;

D3D12_TEXTURE_COPY_LOCATION src = {};
src.pResource = pTexture;
src.Type = D3D12_TEXTURE_COPY_TYPE_SUBRESOURCE_INDEX;
src.SubresourceIndex = 0;

cmdList->CopyTextureRegion(&dst, 0, 0, 0, &src, nullptr);

// Transition: COPY_SOURCE -> PRESENT
D3D12_RESOURCE_BARRIER barrierToPresent = {};
barrierToPresent.Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION;
barrierToPresent.Transition.pResource = pTexture;
barrierToPresent.Transition.Subresource = D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES;
barrierToPresent.Transition.StateBefore = D3D12_RESOURCE_STATE_COPY_SOURCE;
barrierToPresent.Transition.StateAfter = D3D12_RESOURCE_STATE_PRESENT;
cmdList->ResourceBarrier(1, &barrierToPresent);

cmdList->Close();

ID3D12CommandList* pList = cmdList.Get();
pRenderer->Queue->ExecuteCommandLists(1, &pList);

if (!WaitForGpu(pRenderer))
{
GREX_LOG_ERROR("SaveDxTextureAsPNG: WaitForGpu failed");
return false;
}

// Map and convert BGRA -> RGBA, force alpha = 255
void* pMapped = nullptr;
readbackBuffer->Map(0, nullptr, &pMapped);

BitmapRGBA8u bitmap(width, height);
uint8_t* pDst = reinterpret_cast<uint8_t*>(bitmap.GetPixels());
const uint8_t* pSrc = static_cast<const uint8_t*>(pMapped);
const uint32_t rowPitch = footprint.Footprint.RowPitch;

for (uint32_t y = 0; y < height; ++y)
{
const uint8_t* pSrcRow = pSrc + y * rowPitch;
uint8_t* pDstRow = pDst + y * width * 4;
for (uint32_t x = 0; x < width; ++x)
{
pDstRow[x * 4 + 0] = pSrcRow[x * 4 + 2]; // R <- B
pDstRow[x * 4 + 1] = pSrcRow[x * 4 + 1]; // G <- G
pDstRow[x * 4 + 2] = pSrcRow[x * 4 + 0]; // B <- R
pDstRow[x * 4 + 3] = 255; // A <- 1 (swapchain alpha is meaningless)
}
}

readbackBuffer->Unmap(0, nullptr);

return BitmapRGBA8u::Save(absPath, &bitmap);
}

HRESULT CreateTexture(
DxRenderer* pRenderer,
uint32_t width,
Expand Down
4 changes: 3 additions & 1 deletion projects/common/dx_renderer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,4 +221,6 @@ HRESULT CompileHLSL(
std::vector<char>* pDXIL,
std::string* pErrorMsg);

HRESULT CopyDataToBuffer(size_t dataSize, void* pData, ID3D12Resource* pBuffer);
HRESULT CopyDataToBuffer(size_t dataSize, void* pData, ID3D12Resource* pBuffer);

bool SaveDxTextureAsPNG(DxRenderer* pRenderer, ID3D12Resource* pTexture, const std::filesystem::path& absPath);
16 changes: 15 additions & 1 deletion projects/geometry/101_color_cube_d3d12/101_color_cube_d3d12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,9 +188,11 @@ int main(int argc, char** argv)
// *************************************************************************
window->ResetTimer();

uint32_t frameIndex = 0;

while (window->PollEvents())
{
if (args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
if (args.screenshotFrame < 0 && args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
{
break;
}
Expand Down Expand Up @@ -266,12 +268,24 @@ int main(int argc, char** argv)
break;
}

if (!args.screenshotPath.empty() && (args.screenshotFrame < 0 || (int)frameIndex == args.screenshotFrame))
{
SaveDxTextureAsPNG(renderer.get(), swapchainBuffer.Get(), args.screenshotPath);
args.screenshotPath.clear();
if (args.screenshotFrame >= 0)
{
break;
}
}

// Present
if (!SwapchainPresent(renderer.get()))
{
assert(false && "SwapchainPresent failed");
break;
}

++frameIndex;
}

return 0;
Expand Down
2 changes: 2 additions & 0 deletions projects/geometry/101_color_cube_d3d12/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ add_executable(
101_color_cube_d3d12
101_color_cube_d3d12.cpp
${GREX_PROJECTS_COMMON_DIR}/config.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.cpp
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.h
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.cpp
${GREX_PROJECTS_COMMON_DIR}/window.h
Expand Down
15 changes: 14 additions & 1 deletion projects/geometry/102_cornell_box_d3d12/102_cornell_box_d3d12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,11 +232,13 @@ int main(int argc, char** argv)
// *************************************************************************
// Main loop
// *************************************************************************
uint32_t frameIndex = 0;

window->ResetTimer();

while (window->PollEvents())
{
if (args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
if (args.screenshotFrame < 0 && args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
{
break;
}
Expand Down Expand Up @@ -330,13 +332,24 @@ int main(int argc, char** argv)
assert(false && "WaitForGpu failed");
break;
}
if (!args.screenshotPath.empty() && (args.screenshotFrame < 0 || (int)frameIndex == args.screenshotFrame))
{
SaveDxTextureAsPNG(renderer.get(), swapchainBuffer.Get(), args.screenshotPath);
args.screenshotPath.clear();
if (args.screenshotFrame >= 0)
{
break;
}
}

// Present
if (!SwapchainPresent(renderer.get()))
{
assert(false && "SwapchainPresent failed");
break;
}

++frameIndex;
}

return 0;
Expand Down
2 changes: 2 additions & 0 deletions projects/geometry/102_cornell_box_d3d12/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ add_executable(
102_cornell_box_d3d12
102_cornell_box_d3d12.cpp
${GREX_PROJECTS_COMMON_DIR}/config.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.cpp
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.h
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.cpp
${GREX_PROJECTS_COMMON_DIR}/window.h
Expand Down
15 changes: 14 additions & 1 deletion projects/geometry/103_cone_d3d12/103_cone_d3d12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,11 +212,13 @@ int main(int argc, char** argv)
// *************************************************************************
// Main loop
// *************************************************************************
uint32_t frameIndex = 0;

window->ResetTimer();

while (window->PollEvents())
{
if (args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
if (args.screenshotFrame < 0 && args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
{
break;
}
Expand Down Expand Up @@ -304,13 +306,24 @@ int main(int argc, char** argv)
assert(false && "WaitForGpu failed");
break;
}
if (!args.screenshotPath.empty() && (args.screenshotFrame < 0 || (int)frameIndex == args.screenshotFrame))
{
SaveDxTextureAsPNG(renderer.get(), swapchainBuffer.Get(), args.screenshotPath);
args.screenshotPath.clear();
if (args.screenshotFrame >= 0)
{
break;
}
}

// Present
if (!SwapchainPresent(renderer.get()))
{
assert(false && "SwapchainPresent failed");
break;
}

++frameIndex;
}

return 0;
Expand Down
2 changes: 2 additions & 0 deletions projects/geometry/103_cone_d3d12/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ add_executable(
103_cone_d3d12
103_cone_d3d12.cpp
${GREX_PROJECTS_COMMON_DIR}/config.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.cpp
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.h
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.cpp
${GREX_PROJECTS_COMMON_DIR}/window.h
Expand Down
15 changes: 14 additions & 1 deletion projects/geometry/104_debug_tbn_d3d12/104_debug_tbn_d3d12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,11 +265,13 @@ int main(int argc, char** argv)
// *************************************************************************
// Main loop
// *************************************************************************
uint32_t frameIndex = 0;

window->ResetTimer();

while (window->PollEvents())
{
if (args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
if (args.screenshotFrame < 0 && args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
{
break;
}
Expand Down Expand Up @@ -392,13 +394,24 @@ int main(int argc, char** argv)
assert(false && "WaitForGpu failed");
break;
}
if (!args.screenshotPath.empty() && (args.screenshotFrame < 0 || (int)frameIndex == args.screenshotFrame))
{
SaveDxTextureAsPNG(renderer.get(), swapchainBuffer.Get(), args.screenshotPath);
args.screenshotPath.clear();
if (args.screenshotFrame >= 0)
{
break;
}
}

// Present
if (!SwapchainPresent(renderer.get()))
{
assert(false && "SwapchainPresent failed");
break;
}

++frameIndex;
}

return 0;
Expand Down
2 changes: 2 additions & 0 deletions projects/geometry/104_debug_tbn_d3d12/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ add_executable(
104_debug_tbn_d3d12
104_debug_tbn_d3d12.cpp
${GREX_PROJECTS_COMMON_DIR}/config.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.cpp
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.h
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.cpp
${GREX_PROJECTS_COMMON_DIR}/window.h
Expand Down
15 changes: 14 additions & 1 deletion projects/geometry/110_mesh_shader_triangle_d3d12/110_mesh_shader_triangle_d3d12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,11 +240,13 @@ int main(int argc, char** argv)
// *************************************************************************
// Main loop
// *************************************************************************
uint32_t frameIndex = 0;

window->ResetTimer();

while (window->PollEvents())
{
if (args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
if (args.screenshotFrame < 0 && args.autoExitSeconds >= 0 && window->GetElapsedSeconds() >= args.autoExitSeconds)
{
break;
}
Expand Down Expand Up @@ -292,13 +294,24 @@ int main(int argc, char** argv)
assert(false && "WaitForGpu failed");
break;
}
if (!args.screenshotPath.empty() && (args.screenshotFrame < 0 || (int)frameIndex == args.screenshotFrame))
{
SaveDxTextureAsPNG(renderer.get(), swapchainBuffer.Get(), args.screenshotPath);
args.screenshotPath.clear();
if (args.screenshotFrame >= 0)
{
break;
}
}

// Present
if (!SwapchainPresent(renderer.get()))
{
assert(false && "SwapchainPresent failed");
break;
}

++frameIndex;
}

return 0;
Expand Down
2 changes: 2 additions & 0 deletions projects/geometry/110_mesh_shader_triangle_d3d12/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ add_executable(
110_mesh_shader_triangle_d3d12
110_mesh_shader_triangle_d3d12.cpp
${GREX_PROJECTS_COMMON_DIR}/config.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.h
${GREX_PROJECTS_COMMON_DIR}/bitmap.cpp
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.h
${GREX_PROJECTS_COMMON_DIR}/dx_renderer.cpp
${GREX_PROJECTS_COMMON_DIR}/window.h
Expand Down
Loading