thirdpartymirrors/lsfg-vk
1
0
Fork 0
mirror of https://github.com/PancakeTAS/lsfg-vk.git synced 2026-05-10 11:11:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat(bindless): Implement updated backend in lsfg-vk-cli

Browse source
This commit is contained in:
PancakeTAS 2026-04-25 22:34:57 +02:00
parent 8b9deea8d9
commit cee1b7b714
No known key found for this signature in database
13 changed files with 1114 additions and 189 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lsfg-vk-cli/CMakeLists.txt
View file

@ -6,12 +6,14 @@ set(CLI_SOURCES
add_executable(lsfg-vk-cli ${CLI_SOURCES})
target_include_directories(lsfg-vk-cli SYSTEM
PRIVATE thirdparty/include)
target_link_libraries(lsfg-vk-cli
PUBLIC lsfg-vk-common
PUBLIC lsfg-vk-backend)
target_compile_options(lsfg-vk-cli PRIVATE
-Wno-unknown-warning-option
-Wno-unsafe-buffer-usage) # CLI parsing
install(TARGETS lsfg-vk-cli

8
lsfg-vk-cli/src/main.cpp
View file

@ -18,7 +18,7 @@
using namespace lsfgvk::cli;
namespace {
/// print usage information
/// Print usage information
void usage(const std::string& prog) {
std::cerr <<
R"(Validate, benchmark, and debug lsfg-vk.
@ -53,7 +53,7 @@ SUBCOMMAND OPTIONS:
<folder> Path to the debug frames)" << '\n';
}
/// parse the validate command options
/// Parse the validate command options
[[noreturn]] void on_validate(int argc, char** argv) {
validate::Options opts{};
@ -83,7 +83,7 @@ SUBCOMMAND OPTIONS:
std::exit(validate::run(opts));
}
/// parse the benchmark command options
/// Parse the benchmark command options
[[noreturn]] void on_benchmark(int argc, char** argv) {
benchmark::Options opts{};
@ -145,7 +145,7 @@ SUBCOMMAND OPTIONS:
std::exit(benchmark::run(opts));
}
/// parse the debug command options
/// Parse the debug command options
[[noreturn]] void on_debug(int argc, char** argv) {
debug::Options opts{};

145
lsfg-vk-cli/src/tools/benchmark.cpp
View file

@ -1,12 +1,12 @@
/* SPDX-License-Identifier: GPL-3.0-or-later */
#include "benchmark.hpp"
#include "lsfg-vk-backend/lsfgvk.hpp"
#include "lsfg-vk-common/helpers/errors.hpp"
#include "lsfg-vk-common/helpers/paths.hpp"
#include "lsfg-vk-common/vulkan/image.hpp"
#include "lsfg-vk-common/vulkan/timeline_semaphore.hpp"
#include "lsfg-vk-common/vulkan/vulkan.hpp"
#include "lsfg-vk/lsfgvk.hpp"
#include <array>
#include <cstddef>
@ -18,7 +18,6 @@
#include <iostream>
#include <optional>
#include <string>
#include <utility>
#include <vector>
#include <time.h>
@ -29,7 +28,7 @@ using namespace lsfgvk::cli;
using namespace lsfgvk::cli::benchmark;
namespace {
// get current time in milliseconds
// Get current time in milliseconds
uint64_t ms() {
struct timespec ts{};
clock_gettime(CLOCK_MONOTONIC, &ts);
@ -41,29 +40,28 @@ namespace {
int benchmark::run(const Options& opts) {
try {
// parse options
// Parse options
if (opts.flow < 0.25F || opts.flow > 1.0F)
throw ls::error("flow scale must be between 0.25 and 1.0");
throw ls::error("Flow scale must be between 0.25 and 1.0");
if (opts.multiplier < 2)
throw ls::error("multiplier must be 2 or greater");
throw ls::error("Multiplier must be 2 or greater");
if (opts.width <= 0 || opts.height <= 0)
throw ls::error("width and height must be positive integers");
throw ls::error("Width and height must be positive integers");
if (opts.duration <= 0)
throw ls::error("duration must be a positive integer");
throw ls::error("Duration must be a positive integer");
const VkExtent2D extent{
static_cast<uint32_t>(opts.width),
static_cast<uint32_t>(opts.height)
};
// create instance
// Create instance
std::string gpu_name{};
const vk::Vulkan vk{
"lsfg-vk-debug", vk::version{2, 0, 0},
"lsfg-vk-debug-engine", vk::version{2, 0, 0},
[opts](const vk::VulkanInstanceFuncs fi,
"lsfg-vk-debug", vk::version{2, 0, 0},
[opts, gpu_name = &gpu_name](const vk::VulkanInstanceFuncs fi,
const std::vector<VkPhysicalDevice>& devices) {
if (!opts.gpu.has_value())
return devices.front();
for (const VkPhysicalDevice& device : devices) {
VkPhysicalDeviceProperties2 props{
.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PROPERTIES_2
@ -72,84 +70,81 @@ int benchmark::run(const Options& opts) {
auto& properties = props.properties;
std::array<char, 256> devname = std::to_array(properties.deviceName);
devname.at(255) = '\0'; // ensure null-termination
devname.at(255) = '\0'; // Ensure null-termination
if (std::string(devname.data()) == *opts.gpu)
if (!opts.gpu || std::string(devname.data()) == *opts.gpu) {
*gpu_name = std::string(devname.data());
return device;
}
}
throw ls::error("failed to find specified GPU: " + *opts.gpu);
throw ls::error("Failed to find specified GPU: " + *opts.gpu);
}
};
std::pair<int, int> srcfds{};
const vk::Image frame_0{vk,
extent, VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
std::nullopt, &srcfds.first};
const vk::Image frame_1{vk,
extent, VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
std::nullopt, &srcfds.second};
std::vector<vk::Image> destimgs{};
std::vector<int> destfds{};
for (int i = 0; i < (opts.multiplier - 1); i++) {
int fd{};
destimgs.emplace_back(vk,
extent, VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_SRC_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
std::nullopt,
&fd
);
destfds.push_back(fd);
}
int syncfd{};
const vk::TimelineSemaphore sync{vk, 0, std::nullopt, &syncfd};
// initialize backend
// Initialize backend
std::string dll{};
if (opts.dll.has_value())
dll = *opts.dll;
else
dll = ls::findShaderDll();
lsfgvk::backend::Instance lsfgvk{
[opts](
const std::string& gpu_name,
std::pair<const std::string&, const std::string&>,
const std::optional<std::string>&
) {
return opts.gpu.value_or(gpu_name) == gpu_name;
},
dll, opts.allow_fp16
const lsfgvk::Instance lsfgvk{
gpu_name,
dll,
opts.allow_fp16
};
lsfgvk::Context lsfgvk_ctx{
lsfgvk,
extent.width, extent.height,
opts.flow, opts.performance_mode
};
lsfgvk::backend::Context& lsfgvk_ctx = lsfgvk.openContext(
srcfds, destfds,
syncfd, extent.width, extent.height,
false, 1.0F / opts.flow, opts.performance_mode
);
// run the benchmark
// Import resources
const auto fds{lsfgvk_ctx.exportFds()};
const vk::Image source{vk,
extent,
VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
fds.sourceFd, std::nullopt, 2
};
const vk::Image destination{vk,
extent,
VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_SRC_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
fds.destinationFd, std::nullopt, 2 // FIXME: Should be 1
};
const vk::TimelineSemaphore sync{vk,
0,
fds.syncFd
};
// Run the benchmark
const uint32_t total{static_cast<uint32_t>(opts.multiplier) - 1U};
size_t iterations{0};
size_t generated_frames{0};
size_t total_frames{1};
size_t total_frames{0};
size_t idx{1};
uint64_t print_time = ms() + 1000ULL;
const uint64_t end_time = ms() + static_cast<uint64_t>(opts.duration) * 1000ULL;
while (ms() < end_time) {
sync.signal(vk, total_frames++);
lsfgvk.scheduleFrames(lsfgvk_ctx);
lsfgvk_ctx.dispatch(total);
for (size_t i = 0; i < destimgs.size(); i++) {
auto success = sync.wait(vk, total_frames++);
for (size_t i = 0; i < total; i++) {
sync.signal(vk, idx++);
auto success = sync.wait(vk, idx++);
if (!success)
throw ls::error("failed to wait for frame");
total_frames++;
generated_frames++;
}
total_frames++;
iterations++;
if (ms() >= print_time) {
@ -158,25 +153,25 @@ int benchmark::run(const Options& opts) {
}
}
// output results
// Output results
std::cerr << (opts.duration < 40 ? "\r" : "\n");
std::cerr << "benchmark results (ran for " << opts.duration << " seconds):\n";
std::cerr << " iterations: " << iterations << "\n";
std::cerr << " generated frames: " << generated_frames << "\n";
std::cerr << " total frames: " << total_frames << "\n";
std::cerr << "Benchmark results (ran for " << opts.duration << " seconds):\n";
std::cerr << " Iterations: " << iterations << "\n";
std::cerr << " Generated frames: " << generated_frames << "\n";
std::cerr << " Total frames: " << total_frames << "\n";
const auto time = static_cast<double>(opts.duration);
const double fps_generated = static_cast<double>(generated_frames) / time;
const double fps_total = static_cast<double>(total_frames) / time;
std::cerr << std::setprecision(2) << std::fixed;
std::cerr << " fps (generated): " << fps_generated << "fps\n";
std::cerr << " fps (total): " << fps_total << "fps\n";
std::cerr << " FPS (generated): " << fps_generated << "fps\n";
std::cerr << " FPS (total): " << fps_total << "fps\n";
// Wait for idle
lsfgvk_ctx.idle();
// deinitialize lsfg-vk
lsfgvk.closeContext(lsfgvk_ctx);
return EXIT_SUCCESS;
} catch (const std::exception& e) {
std::cerr << "error: " << e.what() << "\n";
std::cerr << "Error: " << e.what() << "\n";
return EXIT_FAILURE;
}
}

12
lsfg-vk-cli/src/tools/benchmark.hpp
View file

@ -7,7 +7,9 @@
namespace lsfgvk::cli::benchmark {
/// options for the "benchmark" command
///
/// Options for the "benchmark" command
///
struct Options {
std::optional<std::string> dll;
bool allow_fp16{false};
@ -22,8 +24,12 @@ namespace lsfgvk::cli::benchmark {
int duration{10};
};
/// run the "benchmark" command
/// @param opts the command options
///
/// Run the "benchmark" command
///
/// @param opts Command options
/// @return Exit code
///
int run(const Options& opts);
}

184
lsfg-vk-cli/src/tools/debug.cpp
View file

@ -1,7 +1,6 @@
/* SPDX-License-Identifier: GPL-3.0-or-later */
#include "debug.hpp"
#include "lsfg-vk-backend/lsfgvk.hpp"
#include "lsfg-vk-common/helpers/errors.hpp"
#include "lsfg-vk-common/helpers/paths.hpp"
#include "lsfg-vk-common/vulkan/buffer.hpp"
@ -10,6 +9,9 @@
#include "lsfg-vk-common/vulkan/timeline_semaphore.hpp"
#include "lsfg-vk-common/vulkan/vulkan.hpp"
#define LSFGVK_PRIV
#include "lsfg-vk/lsfgvk.hpp"
#include <algorithm>
#include <array>
#include <cstddef>
@ -22,25 +24,29 @@
#include <iostream>
#include <optional>
#include <string>
#include <utility>
#include <vector>
#include <dlfcn.h>
#include <renderdoc_app.h>
#include <vulkan/vulkan_core.h>
using namespace lsfgvk::cli;
using namespace lsfgvk::cli::debug;
namespace {
/// uploads an image from a dds file
void upload_image(const vk::Vulkan& vk,
const vk::Image& image, const std::string& path) {
// read image bytecode
/// Upload an image from a DDS file
void uploadDDS(const vk::Vulkan& vk,
const vk::Image& image,
const std::string& path,
uint32_t layer
) {
// Read image data
std::ifstream file(path.data(), std::ios::binary | std::ios::ate);
if (!file.is_open())
throw ls::error("ifstream::ifstream() failed");
std::streamsize size = static_cast<std::streamsize>(file.tellg());
size -= 124 + 4; // dds header and magic bytes
size -= 124 + 4; // DDS header and magic bytes
std::vector<char> code(static_cast<size_t>(size));
file.seekg(124 + 4, std::ios::beg);
@ -49,13 +55,13 @@ namespace {
file.close();
// upload to image
// Upload to image
const vk::Buffer stagingbuf{vk, code.data(), code.size(),
VK_BUFFER_USAGE_TRANSFER_SRC_BIT};
const vk::CommandBuffer cmdbuf{vk};
cmdbuf.begin(vk);
cmdbuf.copyBufferToImage(vk, stagingbuf, image);
cmdbuf.copyBufferToImage(vk, stagingbuf, image, layer);
cmdbuf.end(vk);
const vk::TimelineSemaphore sema{vk, 0};
@ -65,19 +71,19 @@ namespace {
int debug::run(const Options& opts) {
try {
// parse options
// Parse options
if (opts.flow < 0.25F || opts.flow > 1.0F)
throw ls::error("flow scale must be between 0.25 and 1.0");
throw ls::error("Flow scale must be between 0.25 and 1.0");
if (opts.multiplier < 2)
throw ls::error("multiplier must be 2 or greater");
throw ls::error("Multiplier must be 2 or greater");
if (opts.width <= 0 || opts.height <= 0)
throw ls::error("width and height must be positive integers");
throw ls::error("Width and height must be positive integers");
const VkExtent2D extent{
static_cast<uint32_t>(opts.width),
static_cast<uint32_t>(opts.height)
};
if (!std::filesystem::exists(opts.path))
throw ls::error("debug path does not exist: " + opts.path.string());
throw ls::error("Debug path does not exist: " + opts.path.string());
std::vector<std::filesystem::path> paths{};
for (const auto& entry : std::filesystem::directory_iterator(opts.path))
paths.push_back(entry.path());
@ -87,23 +93,22 @@ int debug::run(const Options& opts) {
auto norm_a = fa.find_first_of('.');
if (norm_a == std::string::npos)
throw ls::error("invalid debug file name: " + fa);
throw ls::error("Invalid debug file name: " + fa);
auto norm_b = fb.find_first_of('.');
if (norm_b == std::string::npos)
throw ls::error("invalid debug file name: " + fb);
throw ls::error("Invalid debug file name: " + fb);
return std::stoi(fa.substr(0, norm_a)) < std::stoi(fb.substr(0, norm_b));
});
// create instance
// Create instance
std::string gpu_name{};
const vk::Vulkan vk{
"lsfg-vk-debug", vk::version{2, 0, 0},
"lsfg-vk-debug-engine", vk::version{2, 0, 0},
[opts](const vk::VulkanInstanceFuncs fi,
"lsfg-vk-debug", vk::version{2, 0, 0},
[opts, gpu_name = &gpu_name](const vk::VulkanInstanceFuncs fi,
const std::vector<VkPhysicalDevice>& devices) {
if (!opts.gpu.has_value())
return devices.front();
for (const VkPhysicalDevice& device : devices) {
VkPhysicalDeviceProperties2 props{
.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PROPERTIES_2
@ -112,87 +117,102 @@ int debug::run(const Options& opts) {
auto& properties = props.properties;
std::array<char, 256> devname = std::to_array(properties.deviceName);
devname.at(255) = '\0'; // ensure null-termination
devname.at(255) = '\0'; // Ensure null-termination
if (std::string(devname.data()) == *opts.gpu)
if (!opts.gpu || std::string(devname.data()) == *opts.gpu) {
*gpu_name = std::string(devname.data());
return device;
}
}
throw ls::error("failed to find specified GPU: " + *opts.gpu);
throw ls::error("Failed to find specified GPU: " + *opts.gpu);
}
};
std::pair<int, int> srcfds{};
const vk::Image frame_0{vk,
extent, VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
std::nullopt, &srcfds.first};
const vk::Image frame_1{vk,
extent, VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
std::nullopt, &srcfds.second};
std::vector<vk::Image> destimgs{};
std::vector<int> destfds{};
for (int i = 0; i < (opts.multiplier - 1); i++) {
int fd{};
destimgs.emplace_back(vk,
extent, VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_SRC_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
std::nullopt,
&fd
);
destfds.push_back(fd);
}
int syncfd{};
const vk::TimelineSemaphore sync{vk, 0, std::nullopt, &syncfd};
// initialize backend
// Initialize backend
std::string dll{};
if (opts.dll.has_value())
dll = *opts.dll;
else
dll = ls::findShaderDll();
lsfgvk::backend::Instance lsfgvk{
[opts](
const std::string& gpu_name,
std::pair<const std::string&, const std::string&>,
const std::optional<std::string>&
) {
return opts.gpu.value_or(gpu_name) == gpu_name;
},
dll, opts.allow_fp16
};
lsfgvk::backend::Context& lsfgvk_ctx = lsfgvk.openContext(
srcfds, destfds,
syncfd, extent.width, extent.height,
false, 1.0F / opts.flow, opts.performance_mode
);
// render destination images
size_t idx{1};
for (size_t j = 0; j < paths.size(); j++) {
upload_image(vk,
j % 2 == 0 ? frame_0 : frame_1,
paths.at(j).string()
const lsfgvk::Instance lsfgvk{
gpu_name,
dll,
opts.allow_fp16
};
lsfgvk::Context lsfgvk_ctx{
lsfgvk,
extent.width, extent.height,
opts.flow, opts.performance_mode
};
// Import resources
const auto fds{lsfgvk_ctx.exportFds()};
const vk::Image source{vk,
extent,
VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_DST_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
fds.sourceFd, std::nullopt, 2
};
const vk::Image destination{vk,
extent,
VK_FORMAT_R8G8B8A8_UNORM,
VK_IMAGE_USAGE_TRANSFER_SRC_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
fds.destinationFd, std::nullopt, 2 // FIXME: Should be 1
};
const vk::TimelineSemaphore sync{vk,
0,
fds.syncFd
};
// Try to open RenderDoc
RENDERDOC_API_1_6_0* rdoc_api{nullptr};
RENDERDOC_DevicePointer rdoc_device{nullptr};
if (void* module = dlopen("librenderdoc.so", RTLD_NOW | RTLD_NOLOAD)) {
void* func{dlsym(module, "RENDERDOC_GetAPI")};
auto* GetAPI{reinterpret_cast<pRENDERDOC_GetAPI>(func)}; // NOLINT (unsafe cast)
GetAPI(
eRENDERDOC_API_Version_1_0_0,
reinterpret_cast<void**>(&rdoc_api) // NOLINT (unsafe cast)
);
sync.signal(vk, idx++);
lsfgvk.scheduleFrames(lsfgvk_ctx);
rdoc_device = RENDERDOC_DEVICEPOINTER_FROM_VKINSTANCE(lsfgvk._instance());
}
for (size_t i = 0; i < destimgs.size(); i++) {
auto success = sync.wait(vk, idx++);
if (!success)
throw ls::error("failed to wait for frame");
// Render destination images
const uint32_t total{static_cast<uint32_t>(opts.multiplier) - 1U};
for (size_t j = 0; j < paths.size(); j++) {
uploadDDS(vk, source, paths.at(j).string(), j % 2);
if (rdoc_api) {
rdoc_api->StartFrameCapture(rdoc_device, nullptr);
}
const size_t idx{(j + 1) * total * 2};
sync.signal(vk, idx - 1);
lsfgvk_ctx.dispatch(total);
auto success = sync.wait(vk, idx);
if (!success)
throw ls::error("Failed to wait for frame");
if (rdoc_api) {
lsfgvk_ctx.idle();
rdoc_api->EndFrameCapture(rdoc_device, nullptr);
}
}
// deinitialize lsfg-vk
lsfgvk.closeContext(lsfgvk_ctx);
// Wait for idle
lsfgvk_ctx.idle();
return EXIT_SUCCESS;
} catch (const std::exception& e) {
std::cerr << "error: " << e.what() << "\n";
std::cerr << "Error: " << e.what() << "\n";
return EXIT_FAILURE;
}
}

18
lsfg-vk-cli/src/tools/debug.hpp
View file

@ -8,23 +8,29 @@
namespace lsfgvk::cli::debug {
/// options for the "debug" command
///
/// Options for the "debug" command
///
struct Options {
std::optional<std::string> dll;
bool allow_fp16{true};
bool allow_fp16{false};
int width{1920};
int height{1080};
float flow{0.85F};
float flow{1.0F};
int multiplier{2};
bool performance_mode{true};
bool performance_mode{false};
std::optional<std::string> gpu;
std::filesystem::path path;
};
/// run the "debug" command
/// @param opts the command options
///
/// Run the "debug" command
///
/// @param opts Command options
/// @return Exit code
///
int run(const Options& opts);
}

2
lsfg-vk-cli/src/tools/validate.cpp
View file

@ -16,7 +16,7 @@ int validate::run(const Options& opts) {
path = *opts.config;
if (!std::filesystem::exists(path)) {
std::cerr << "Validation failed: configuration file does not exist\n";
std::cerr << "Validation failed: Configuration file does not exist\n";
return 1;
}

12
lsfg-vk-cli/src/tools/validate.hpp
View file

@ -7,13 +7,19 @@
namespace lsfgvk::cli::validate {
/// options for the "validate" command
///
/// Options for the "validate" command
///
struct Options {
std::optional<std::string> config;
};
/// run the "validate" command
/// @param opts the command options
///
/// Run the "validate" command
///
/// @param opts Command options
/// @return Exit code
///
int run(const Options& opts);
}

875
lsfg-vk-cli/thirdparty/include/renderdoc_app.h vendored Normal file
View file

@ -0,0 +1,875 @@
/******************************************************************************
* The MIT License (MIT)
*
* Copyright (c) 2015-2026 Baldur Karlsson
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
******************************************************************************/
#pragma once
//////////////////////////////////////////////////////////////////////////////////////////////////
//
// Documentation for the API is available at https://renderdoc.org/docs/in_application_api.html
//
#if !defined(RENDERDOC_NO_STDINT)
#include <stdint.h>
#endif
#if defined(WIN32) || defined(__WIN32__) || defined(_WIN32) || defined(_MSC_VER)
#define RENDERDOC_CC __cdecl
#elif defined(__linux__) || defined(__FreeBSD__) || defined(__sun__) || defined(__OpenBSD__)
#define RENDERDOC_CC
#elif defined(__APPLE__)
#define RENDERDOC_CC
#else
#error "Unknown platform"
#endif
#ifdef __cplusplus
extern "C" {
#endif
//////////////////////////////////////////////////////////////////////////////////////////////////
// Constants not used directly in below API
// This is a GUID/magic value used for when applications pass a path where shader debug
// information can be found to match up with a stripped shader.
// the define can be used like so: const GUID RENDERDOC_ShaderDebugMagicValue =
// RENDERDOC_ShaderDebugMagicValue_value
#define RENDERDOC_ShaderDebugMagicValue_struct \
{ \
0xeab25520, 0x6670, 0x4865, 0x84, 0x29, 0x6c, 0x8, 0x51, 0x54, 0x00, 0xff \
}
// as an alternative when you want a byte array (assuming x86 endianness):
#define RENDERDOC_ShaderDebugMagicValue_bytearray \
{ \
0x20, 0x55, 0xb2, 0xea, 0x70, 0x66, 0x65, 0x48, 0x84, 0x29, 0x6c, 0x8, 0x51, 0x54, 0x00, 0xff \
}
// truncated version when only a uint64_t is available (e.g. Vulkan tags):
#define RENDERDOC_ShaderDebugMagicValue_truncated 0x48656670eab25520ULL
// this is a magic value for vulkan user tags to indicate which dispatchable API objects are which
// for object annotations
#define RENDERDOC_APIObjectAnnotationHelper 0xfbb3b337b664d0adULL
//////////////////////////////////////////////////////////////////////////////////////////////////
// RenderDoc capture options
//
typedef enum RENDERDOC_CaptureOption
{
// Allow the application to enable vsync
//
// Default - enabled
//
// 1 - The application can enable or disable vsync at will
// 0 - vsync is force disabled
eRENDERDOC_Option_AllowVSync = 0,
// Allow the application to enable fullscreen
//
// Default - enabled
//
// 1 - The application can enable or disable fullscreen at will
// 0 - fullscreen is force disabled
eRENDERDOC_Option_AllowFullscreen = 1,
// Record API debugging events and messages
//
// Default - disabled
//
// 1 - Enable built-in API debugging features and records the results into
// the capture, which is matched up with events on replay
// 0 - no API debugging is forcibly enabled
eRENDERDOC_Option_APIValidation = 2,
eRENDERDOC_Option_DebugDeviceMode = 2, // deprecated name of this enum
// Capture CPU callstacks for API events
//
// Default - disabled
//
// 1 - Enables capturing of callstacks
// 0 - no callstacks are captured
eRENDERDOC_Option_CaptureCallstacks = 3,
// When capturing CPU callstacks, only capture them from actions.
// This option does nothing without the above option being enabled
//
// Default - disabled
//
// 1 - Only captures callstacks for actions.
// Ignored if CaptureCallstacks is disabled
// 0 - Callstacks, if enabled, are captured for every event.
eRENDERDOC_Option_CaptureCallstacksOnlyDraws = 4,
eRENDERDOC_Option_CaptureCallstacksOnlyActions = 4,
// Specify a delay in seconds to wait for a debugger to attach, after
// creating or injecting into a process, before continuing to allow it to run.
//
// 0 indicates no delay, and the process will run immediately after injection
//
// Default - 0 seconds
//
eRENDERDOC_Option_DelayForDebugger = 5,
// Verify buffer access. This includes checking the memory returned by a Map() call to
// detect any out-of-bounds modification, as well as initialising buffers with undefined contents
// to a marker value to catch use of uninitialised memory.
//
// NOTE: This option is only valid for OpenGL and D3D11. Explicit APIs such as D3D12 and Vulkan do
// not do the same kind of interception & checking and undefined contents are really undefined.
//
// Default - disabled
//
// 1 - Verify buffer access
// 0 - No verification is performed, and overwriting bounds may cause crashes or corruption in
// RenderDoc.
eRENDERDOC_Option_VerifyBufferAccess = 6,
// The old name for eRENDERDOC_Option_VerifyBufferAccess was eRENDERDOC_Option_VerifyMapWrites.
// This option now controls the filling of uninitialised buffers with 0xdddddddd which was
// previously always enabled
eRENDERDOC_Option_VerifyMapWrites = eRENDERDOC_Option_VerifyBufferAccess,
// Hooks any system API calls that create child processes, and injects
// RenderDoc into them recursively with the same options.
//
// Default - disabled
//
// 1 - Hooks into spawned child processes
// 0 - Child processes are not hooked by RenderDoc
eRENDERDOC_Option_HookIntoChildren = 7,
// By default RenderDoc only includes resources in the final capture necessary
// for that frame, this allows you to override that behaviour.
//
// Default - disabled
//
// 1 - all live resources at the time of capture are included in the capture
// and available for inspection
// 0 - only the resources referenced by the captured frame are included
eRENDERDOC_Option_RefAllResources = 8,
// **NOTE**: As of RenderDoc v1.1 this option has been deprecated. Setting or
// getting it will be ignored, to allow compatibility with older versions.
// In v1.1 the option acts as if it's always enabled.
//
// By default RenderDoc skips saving initial states for resources where the
// previous contents don't appear to be used, assuming that writes before
// reads indicate previous contents aren't used.
//
// Default - disabled
//
// 1 - initial contents at the start of each captured frame are saved, even if
// they are later overwritten or cleared before being used.
// 0 - unless a read is detected, initial contents will not be saved and will
// appear as black or empty data.
eRENDERDOC_Option_SaveAllInitials = 9,
// In APIs that allow for the recording of command lists to be replayed later,
// RenderDoc may choose to not capture command lists before a frame capture is
// triggered, to reduce overheads. This means any command lists recorded once
// and replayed many times will not be available and may cause a failure to
// capture.
//
// NOTE: This is only true for APIs where multithreading is difficult or
// discouraged. Newer APIs like Vulkan and D3D12 will ignore this option
// and always capture all command lists since the API is heavily oriented
// around it and the overheads have been reduced by API design.
//
// 1 - All command lists are captured from the start of the application
// 0 - Command lists are only captured if their recording begins during
// the period when a frame capture is in progress.
eRENDERDOC_Option_CaptureAllCmdLists = 10,
// Mute API debugging output when the API validation mode option is enabled
//
// Default - enabled
//
// 1 - Mute any API debug messages from being displayed or passed through
// 0 - API debugging is displayed as normal
eRENDERDOC_Option_DebugOutputMute = 11,
// Option to allow vendor extensions to be used even when they may be
// incompatible with RenderDoc and cause corrupted replays or crashes.
//
// Default - inactive
//
// No values are documented, this option should only be used when absolutely
// necessary as directed by a RenderDoc developer.
eRENDERDOC_Option_AllowUnsupportedVendorExtensions = 12,
// Define a soft memory limit which some APIs may aim to keep overhead under where
// possible. Anything above this limit will where possible be saved directly to disk during
// capture.
// This will cause increased disk space use (which may cause a capture to fail if disk space is
// exhausted) as well as slower capture times.
//
// Not all memory allocations may be deferred like this so it is not a guarantee of a memory
// limit.
//
// Units are in MBs, suggested values would range from 200MB to 1000MB.
//
// Default - 0 Megabytes
eRENDERDOC_Option_SoftMemoryLimit = 13,
} RENDERDOC_CaptureOption;
// Sets an option that controls how RenderDoc behaves on capture.
//
// Returns 1 if the option and value are valid
// Returns 0 if either is invalid and the option is unchanged
typedef int(RENDERDOC_CC *pRENDERDOC_SetCaptureOptionU32)(RENDERDOC_CaptureOption opt, uint32_t val);
typedef int(RENDERDOC_CC *pRENDERDOC_SetCaptureOptionF32)(RENDERDOC_CaptureOption opt, float val);
// Gets the current value of an option as a uint32_t
//
// If the option is invalid, 0xffffffff is returned
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_GetCaptureOptionU32)(RENDERDOC_CaptureOption opt);
// Gets the current value of an option as a float
//
// If the option is invalid, -FLT_MAX is returned
typedef float(RENDERDOC_CC *pRENDERDOC_GetCaptureOptionF32)(RENDERDOC_CaptureOption opt);
typedef enum RENDERDOC_InputButton
{
// '0' - '9' matches ASCII values
eRENDERDOC_Key_0 = 0x30,
eRENDERDOC_Key_1 = 0x31,
eRENDERDOC_Key_2 = 0x32,
eRENDERDOC_Key_3 = 0x33,
eRENDERDOC_Key_4 = 0x34,
eRENDERDOC_Key_5 = 0x35,
eRENDERDOC_Key_6 = 0x36,
eRENDERDOC_Key_7 = 0x37,
eRENDERDOC_Key_8 = 0x38,
eRENDERDOC_Key_9 = 0x39,
// 'A' - 'Z' matches ASCII values
eRENDERDOC_Key_A = 0x41,
eRENDERDOC_Key_B = 0x42,
eRENDERDOC_Key_C = 0x43,
eRENDERDOC_Key_D = 0x44,
eRENDERDOC_Key_E = 0x45,
eRENDERDOC_Key_F = 0x46,
eRENDERDOC_Key_G = 0x47,
eRENDERDOC_Key_H = 0x48,
eRENDERDOC_Key_I = 0x49,
eRENDERDOC_Key_J = 0x4A,
eRENDERDOC_Key_K = 0x4B,
eRENDERDOC_Key_L = 0x4C,
eRENDERDOC_Key_M = 0x4D,
eRENDERDOC_Key_N = 0x4E,
eRENDERDOC_Key_O = 0x4F,
eRENDERDOC_Key_P = 0x50,
eRENDERDOC_Key_Q = 0x51,
eRENDERDOC_Key_R = 0x52,
eRENDERDOC_Key_S = 0x53,
eRENDERDOC_Key_T = 0x54,
eRENDERDOC_Key_U = 0x55,
eRENDERDOC_Key_V = 0x56,
eRENDERDOC_Key_W = 0x57,
eRENDERDOC_Key_X = 0x58,
eRENDERDOC_Key_Y = 0x59,
eRENDERDOC_Key_Z = 0x5A,
// leave the rest of the ASCII range free
// in case we want to use it later
eRENDERDOC_Key_NonPrintable = 0x100,
eRENDERDOC_Key_Divide,
eRENDERDOC_Key_Multiply,
eRENDERDOC_Key_Subtract,
eRENDERDOC_Key_Plus,
eRENDERDOC_Key_F1,
eRENDERDOC_Key_F2,
eRENDERDOC_Key_F3,
eRENDERDOC_Key_F4,
eRENDERDOC_Key_F5,
eRENDERDOC_Key_F6,
eRENDERDOC_Key_F7,
eRENDERDOC_Key_F8,
eRENDERDOC_Key_F9,
eRENDERDOC_Key_F10,
eRENDERDOC_Key_F11,
eRENDERDOC_Key_F12,
eRENDERDOC_Key_Home,
eRENDERDOC_Key_End,
eRENDERDOC_Key_Insert,
eRENDERDOC_Key_Delete,
eRENDERDOC_Key_PageUp,
eRENDERDOC_Key_PageDn,
eRENDERDOC_Key_Backspace,
eRENDERDOC_Key_Tab,
eRENDERDOC_Key_PrtScrn,
eRENDERDOC_Key_Pause,
eRENDERDOC_Key_Max,
} RENDERDOC_InputButton;
// Sets which key or keys can be used to toggle focus between multiple windows
//
// If keys is NULL or num is 0, toggle keys will be disabled
typedef void(RENDERDOC_CC *pRENDERDOC_SetFocusToggleKeys)(RENDERDOC_InputButton *keys, int num);
// Sets which key or keys can be used to capture the next frame
//
// If keys is NULL or num is 0, captures keys will be disabled
typedef void(RENDERDOC_CC *pRENDERDOC_SetCaptureKeys)(RENDERDOC_InputButton *keys, int num);
typedef enum RENDERDOC_OverlayBits
{
// This single bit controls whether the overlay is enabled or disabled globally
eRENDERDOC_Overlay_Enabled = 0x1,
// Show the average framerate over several seconds as well as min/max
eRENDERDOC_Overlay_FrameRate = 0x2,
// Show the current frame number
eRENDERDOC_Overlay_FrameNumber = 0x4,
// Show a list of recent captures, and how many captures have been made
eRENDERDOC_Overlay_CaptureList = 0x8,
// Default values for the overlay mask
eRENDERDOC_Overlay_Default = (eRENDERDOC_Overlay_Enabled | eRENDERDOC_Overlay_FrameRate |
eRENDERDOC_Overlay_FrameNumber | eRENDERDOC_Overlay_CaptureList),
// Enable all bits
eRENDERDOC_Overlay_All = 0x7ffffff,
// Disable all bits
eRENDERDOC_Overlay_None = 0,
} RENDERDOC_OverlayBits;
// returns the overlay bits that have been set
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_GetOverlayBits)(void);
// sets the overlay bits with an and & or mask
typedef void(RENDERDOC_CC *pRENDERDOC_MaskOverlayBits)(uint32_t And, uint32_t Or);
// this function will attempt to remove RenderDoc's hooks in the application.
//
// Note: that this can only work correctly if done immediately after
// the module is loaded, before any API work happens. RenderDoc will remove its
// injected hooks and shut down. Behaviour is undefined if this is called
// after any API functions have been called, and there is still no guarantee of
// success.
typedef void(RENDERDOC_CC *pRENDERDOC_RemoveHooks)(void);
// DEPRECATED: compatibility for code compiled against pre-1.4.1 headers.
typedef pRENDERDOC_RemoveHooks pRENDERDOC_Shutdown;
// This function will unload RenderDoc's crash handler.
//
// If you use your own crash handler and don't want RenderDoc's handler to
// intercede, you can call this function to unload it and any unhandled
// exceptions will pass to the next handler.
typedef void(RENDERDOC_CC *pRENDERDOC_UnloadCrashHandler)(void);
// Sets the capture file path template
//
// pathtemplate is a UTF-8 string that gives a template for how captures will be named
// and where they will be saved.
//
// Any extension is stripped off the path, and captures are saved in the directory
// specified, and named with the filename and the frame number appended. If the
// directory does not exist it will be created, including any parent directories.
//
// If pathtemplate is NULL, the template will remain unchanged
//
// Example:
//
// SetCaptureFilePathTemplate("my_captures/example");
//
// Capture #1 -> my_captures/example_frame123.rdc
// Capture #2 -> my_captures/example_frame456.rdc
typedef void(RENDERDOC_CC *pRENDERDOC_SetCaptureFilePathTemplate)(const char *pathtemplate);
// returns the current capture path template, see SetCaptureFileTemplate above, as a UTF-8 string
typedef const char *(RENDERDOC_CC *pRENDERDOC_GetCaptureFilePathTemplate)(void);
// DEPRECATED: compatibility for code compiled against pre-1.1.2 headers.
typedef pRENDERDOC_SetCaptureFilePathTemplate pRENDERDOC_SetLogFilePathTemplate;
typedef pRENDERDOC_GetCaptureFilePathTemplate pRENDERDOC_GetLogFilePathTemplate;
// returns the number of captures that have been made
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_GetNumCaptures)(void);
// This function returns the details of a capture, by index. New captures are added
// to the end of the list.
//
// filename will be filled with the absolute path to the capture file, as a UTF-8 string
// pathlength will be written with the length in bytes of the filename string
// timestamp will be written with the time of the capture, in seconds since the Unix epoch
//
// Any of the parameters can be NULL and they'll be skipped.
//
// The function will return 1 if the capture index is valid, or 0 if the index is invalid
// If the index is invalid, the values will be unchanged
//
// Note: when captures are deleted in the UI they will remain in this list, so the
// capture path may not exist anymore.
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_GetCapture)(uint32_t idx, char *filename,
uint32_t *pathlength, uint64_t *timestamp);
// Sets the comments associated with a capture file. These comments are displayed in the
// UI program when opening.
//
// filePath should be a path to the capture file to add comments to. If set to NULL or ""
// the most recent capture file created made will be used instead.
// comments should be a NULL-terminated UTF-8 string to add as comments.
//
// Any existing comments will be overwritten.
typedef void(RENDERDOC_CC *pRENDERDOC_SetCaptureFileComments)(const char *filePath,
const char *comments);
// returns 1 if the RenderDoc UI is connected to this application, 0 otherwise
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_IsTargetControlConnected)(void);
// DEPRECATED: compatibility for code compiled against pre-1.1.1 headers.
// This was renamed to IsTargetControlConnected in API 1.1.1, the old typedef is kept here for
// backwards compatibility with old code, it is castable either way since it's ABI compatible
// as the same function pointer type.
typedef pRENDERDOC_IsTargetControlConnected pRENDERDOC_IsRemoteAccessConnected;
// This function will launch the Replay UI associated with the RenderDoc library injected
// into the running application.
//
// if connectTargetControl is 1, the Replay UI will be launched with a command line parameter
// to connect to this application
// cmdline is the rest of the command line, as a UTF-8 string. E.g. a captures to open
// if cmdline is NULL, the command line will be empty.
//
// returns the PID of the replay UI if successful, 0 if not successful.
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_LaunchReplayUI)(uint32_t connectTargetControl,
const char *cmdline);
// RenderDoc can return a higher version than requested if it's backwards compatible,
// this function returns the actual version returned. If a parameter is NULL, it will be
// ignored and the others will be filled out.
typedef void(RENDERDOC_CC *pRENDERDOC_GetAPIVersion)(int *major, int *minor, int *patch);
// Requests that the replay UI show itself (if hidden or not the current top window). This can be
// used in conjunction with IsTargetControlConnected and LaunchReplayUI to intelligently handle
// showing the UI after making a capture.
//
// This will return 1 if the request was successfully passed on, though it's not guaranteed that
// the UI will be on top in all cases depending on OS rules. It will return 0 if there is no current
// target control connection to make such a request, or if there was another error
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_ShowReplayUI)(void);
//////////////////////////////////////////////////////////////////////////
// Capturing functions
//
// A device pointer is a pointer to the API's root handle.
//
// This would be an ID3D11Device, HGLRC/GLXContext, ID3D12Device, etc
typedef void *RENDERDOC_DevicePointer;
// A window handle is the OS's native window handle
//
// This would be an HWND, GLXDrawable, etc
typedef void *RENDERDOC_WindowHandle;
// A helper macro for Vulkan, where the device handle cannot be used directly.
//
// Passing the VkInstance to this macro will return the RENDERDOC_DevicePointer to use.
//
// Specifically, the value needed is the dispatch table pointer, which sits as the first
// pointer-sized object in the memory pointed to by the VkInstance. Thus we cast to a void** and
// indirect once.
#define RENDERDOC_DEVICEPOINTER_FROM_VKINSTANCE(inst) (*((void **)(inst)))
// This sets the RenderDoc in-app overlay in the API/window pair as 'active' and it will
// respond to keypresses. Neither parameter can be NULL
typedef void(RENDERDOC_CC *pRENDERDOC_SetActiveWindow)(RENDERDOC_DevicePointer device,
RENDERDOC_WindowHandle wndHandle);
// capture the next frame on whichever window and API is currently considered active
typedef void(RENDERDOC_CC *pRENDERDOC_TriggerCapture)(void);
// capture the next N frames on whichever window and API is currently considered active
typedef void(RENDERDOC_CC *pRENDERDOC_TriggerMultiFrameCapture)(uint32_t numFrames);
// When choosing either a device pointer or a window handle to capture, you can pass NULL.
// Passing NULL specifies a 'wildcard' match against anything. This allows you to specify
// any API rendering to a specific window, or a specific API instance rendering to any window,
// or in the simplest case of one window and one API, you can just pass NULL for both.
//
// In either case, if there are two or more possible matching (device,window) pairs it
// is undefined which one will be captured.
//
// Note: for headless rendering you can pass NULL for the window handle and either specify
// a device pointer or leave it NULL as above.
// Immediately starts capturing API calls on the specified device pointer and window handle.
//
// If there is no matching thing to capture (e.g. no supported API has been initialised),
// this will do nothing.
//
// The results are undefined (including crashes) if two captures are started overlapping,
// even on separate devices and/oror windows.
typedef void(RENDERDOC_CC *pRENDERDOC_StartFrameCapture)(RENDERDOC_DevicePointer device,
RENDERDOC_WindowHandle wndHandle);
// Returns whether or not a frame capture is currently ongoing anywhere.
//
// This will return 1 if a capture is ongoing, and 0 if there is no capture running
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_IsFrameCapturing)(void);
// Ends capturing immediately.
//
// This will return 1 if the capture succeeded, and 0 if there was an error capturing.
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_EndFrameCapture)(RENDERDOC_DevicePointer device,
RENDERDOC_WindowHandle wndHandle);
// Ends capturing immediately and discard any data stored without saving to disk.
//
// This will return 1 if the capture was discarded, and 0 if there was an error or no capture
// was in progress
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_DiscardFrameCapture)(RENDERDOC_DevicePointer device,
RENDERDOC_WindowHandle wndHandle);
// Only valid to be called between a call to StartFrameCapture and EndFrameCapture. Gives a custom
// title to the capture produced which will be displayed in the UI.
//
// If multiple captures are ongoing, this title will be applied to the first capture to end after
// this call. The second capture to end will have no title, unless this function is called again.
//
// Calling this function has no effect if no capture is currently running, and if it is called
// multiple times only the last title will be used.
typedef void(RENDERDOC_CC *pRENDERDOC_SetCaptureTitle)(const char *title);
// Annotations API:
//
// These functions allow you to specify annotations either on a per-command level, or a per-object
// level.
//
// Basic types of annotations are supported, as well as vector versions and references to API objects.
//
// The annotations are stored as keys, with the key being a dot-separated path allowing arbitrary
// nesting and user organisation. The keys are sorted in human order so `foo.2.bar` will be displayed
// before `foo.10.bar` to allow creation of arrays if desired.
//
// Deleting an annotation can be done by assigning an empty value to it.
// the type of an annotation value, or Empty to delete an annotation
typedef enum RENDERDOC_AnnotationType
{
eRENDERDOC_Empty,
eRENDERDOC_Bool,
eRENDERDOC_Int32,
eRENDERDOC_UInt32,
eRENDERDOC_Int64,
eRENDERDOC_UInt64,
eRENDERDOC_Float,
eRENDERDOC_Double,
eRENDERDOC_String,
eRENDERDOC_APIObject,
eRENDERDOC_AnnotationMax = 0x7FFFFFFF,
} RENDERDOC_AnnotationType;
// a union with vector annotation value data
typedef union RENDERDOC_AnnotationVectorValue
{
bool boolean[4];
int32_t int32[4];
int64_t int64[4];
uint32_t uint32[4];
uint64_t uint64[4];
float float32[4];
double float64[4];
} RENDERDOC_AnnotationVectorValue;
// a union with scalar annotation value data
typedef union RENDERDOC_AnnotationValue
{
bool boolean;
int32_t int32;
int64_t int64;
uint32_t uint32;
uint64_t uint64;
float float32;
double float64;
RENDERDOC_AnnotationVectorValue vector;
const char *string;
void *apiObject;
} RENDERDOC_AnnotationValue;
// a struct for specifying a GL object, as we don't have pointers we can use so instead we specify a
// pointer to this struct giving both the type and the name
typedef struct RENDERDOC_GLResourceReference
{
// this is the same GLenum identifier as passed to glObjectLabel
uint32_t identifier;
uint32_t name;
} GLResourceReference;
// simple C++ helpers to avoid the need for a temporary objects for value passing and GL object specification
#ifdef __cplusplus
struct RDGLObjectHelper
{
RENDERDOC_GLResourceReference gl;
RDGLObjectHelper(uint32_t identifier, uint32_t name)
{
gl.identifier = identifier;
gl.name = name;
}
operator RENDERDOC_GLResourceReference *() { return &gl; }
};
struct RDAnnotationHelper
{
RENDERDOC_AnnotationValue val;
RDAnnotationHelper(bool b) { val.boolean = b; }
RDAnnotationHelper(int32_t i) { val.int32 = i; }
RDAnnotationHelper(int64_t i) { val.int64 = i; }
RDAnnotationHelper(uint32_t i) { val.uint32 = i; }
RDAnnotationHelper(uint64_t i) { val.uint64 = i; }
RDAnnotationHelper(float f) { val.float32 = f; }
RDAnnotationHelper(double d) { val.float64 = d; }
RDAnnotationHelper(const char *s) { val.string = s; }
operator RENDERDOC_AnnotationValue *() { return &val; }
};
#endif
// The device is specified in the same way as other API calls that take a RENDERDOC_DevicePointer
// to specify the device.
//
// The object or queue/commandbuffer will depend on the graphics API in question.
//
// Return value:
// 0 - The annotation was applied successfully.
// 1 - The device is unknown/invalid
// 2 - The device is valid but the annotation is not supported for API-specific reasons, such as an
// unrecognised or invalid object or queue/commandbuffer
// 3 - The call is ill-formed or invalid e.g. empty is specified with a value pointer, or non-empty
// is specified with a NULL value pointer
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_SetObjectAnnotation)(RENDERDOC_DevicePointer device,
void *object, const char *key,
RENDERDOC_AnnotationType valueType,
uint32_t valueVectorWidth,
const RENDERDOC_AnnotationValue *value);
typedef uint32_t(RENDERDOC_CC *pRENDERDOC_SetCommandAnnotation)(
RENDERDOC_DevicePointer device, void *queueOrCommandBuffer, const char *key,
RENDERDOC_AnnotationType valueType, uint32_t valueVectorWidth,
const RENDERDOC_AnnotationValue *value);
//////////////////////////////////////////////////////////////////////////////////////////////////
// RenderDoc API versions
//
// RenderDoc uses semantic versioning (http://semver.org/).
//
// MAJOR version is incremented when incompatible API changes happen.
// MINOR version is incremented when functionality is added in a backwards-compatible manner.
// PATCH version is incremented when backwards-compatible bug fixes happen.
//
// Note that this means the API returned can be higher than the one you might have requested.
// e.g. if you are running against a newer RenderDoc that supports 1.0.1, it will be returned
// instead of 1.0.0. You can check this with the GetAPIVersion entry point
typedef enum RENDERDOC_Version
{
eRENDERDOC_API_Version_1_0_0 = 10000, // RENDERDOC_API_1_0_0 = 1 00 00
eRENDERDOC_API_Version_1_0_1 = 10001, // RENDERDOC_API_1_0_1 = 1 00 01
eRENDERDOC_API_Version_1_0_2 = 10002, // RENDERDOC_API_1_0_2 = 1 00 02
eRENDERDOC_API_Version_1_1_0 = 10100, // RENDERDOC_API_1_1_0 = 1 01 00
eRENDERDOC_API_Version_1_1_1 = 10101, // RENDERDOC_API_1_1_1 = 1 01 01
eRENDERDOC_API_Version_1_1_2 = 10102, // RENDERDOC_API_1_1_2 = 1 01 02
eRENDERDOC_API_Version_1_2_0 = 10200, // RENDERDOC_API_1_2_0 = 1 02 00
eRENDERDOC_API_Version_1_3_0 = 10300, // RENDERDOC_API_1_3_0 = 1 03 00
eRENDERDOC_API_Version_1_4_0 = 10400, // RENDERDOC_API_1_4_0 = 1 04 00
eRENDERDOC_API_Version_1_4_1 = 10401, // RENDERDOC_API_1_4_1 = 1 04 01
eRENDERDOC_API_Version_1_4_2 = 10402, // RENDERDOC_API_1_4_2 = 1 04 02
eRENDERDOC_API_Version_1_5_0 = 10500, // RENDERDOC_API_1_5_0 = 1 05 00
eRENDERDOC_API_Version_1_6_0 = 10600, // RENDERDOC_API_1_6_0 = 1 06 00
eRENDERDOC_API_Version_1_7_0 = 10700, // RENDERDOC_API_1_7_0 = 1 07 00
} RENDERDOC_Version;
// API version changelog:
//
// 1.0.0 - initial release
// 1.0.1 - Bugfix: IsFrameCapturing() was returning false for captures that were triggered
// by keypress or TriggerCapture, instead of Start/EndFrameCapture.
// 1.0.2 - Refactor: Renamed eRENDERDOC_Option_DebugDeviceMode to eRENDERDOC_Option_APIValidation
// 1.1.0 - Add feature: TriggerMultiFrameCapture(). Backwards compatible with 1.0.x since the new
// function pointer is added to the end of the struct, the original layout is identical
// 1.1.1 - Refactor: Renamed remote access to target control (to better disambiguate from remote
// replay/remote server concept in replay UI)
// 1.1.2 - Refactor: Renamed "log file" in function names to just capture, to clarify that these
// are captures and not debug logging files. This is the first API version in the v1.0
// branch.
// 1.2.0 - Added feature: SetCaptureFileComments() to add comments to a capture file that will be
// displayed in the UI program on load.
// 1.3.0 - Added feature: New capture option eRENDERDOC_Option_AllowUnsupportedVendorExtensions
// which allows users to opt-in to allowing unsupported vendor extensions to function.
// Should be used at the user's own risk.
// Refactor: Renamed eRENDERDOC_Option_VerifyMapWrites to
// eRENDERDOC_Option_VerifyBufferAccess, which now also controls initialisation to
// 0xdddddddd of uninitialised buffer contents.
// 1.4.0 - Added feature: DiscardFrameCapture() to discard a frame capture in progress and stop
// capturing without saving anything to disk.
// 1.4.1 - Refactor: Renamed Shutdown to RemoveHooks to better clarify what is happening
// 1.4.2 - Refactor: Renamed 'draws' to 'actions' in callstack capture option.
// 1.5.0 - Added feature: ShowReplayUI() to request that the replay UI show itself if connected
// 1.6.0 - Added feature: SetCaptureTitle() which can be used to set a title for a
// capture made with StartFrameCapture() or EndFrameCapture()
// 1.7.0 - Added feature: SetObjectAnnotation() / SetCommandAnnotation() for adding rich
// annotations to objects and command streams
typedef struct RENDERDOC_API_1_7_0
{
pRENDERDOC_GetAPIVersion GetAPIVersion;
pRENDERDOC_SetCaptureOptionU32 SetCaptureOptionU32;
pRENDERDOC_SetCaptureOptionF32 SetCaptureOptionF32;
pRENDERDOC_GetCaptureOptionU32 GetCaptureOptionU32;
pRENDERDOC_GetCaptureOptionF32 GetCaptureOptionF32;
pRENDERDOC_SetFocusToggleKeys SetFocusToggleKeys;
pRENDERDOC_SetCaptureKeys SetCaptureKeys;
pRENDERDOC_GetOverlayBits GetOverlayBits;
pRENDERDOC_MaskOverlayBits MaskOverlayBits;
// Shutdown was renamed to RemoveHooks in 1.4.1.
// These unions allow old code to continue compiling without changes
union
{
pRENDERDOC_Shutdown Shutdown;
pRENDERDOC_RemoveHooks RemoveHooks;
};
pRENDERDOC_UnloadCrashHandler UnloadCrashHandler;
// Get/SetLogFilePathTemplate was renamed to Get/SetCaptureFilePathTemplate in 1.1.2.
// These unions allow old code to continue compiling without changes
union
{
// deprecated name
pRENDERDOC_SetLogFilePathTemplate SetLogFilePathTemplate;
// current name
pRENDERDOC_SetCaptureFilePathTemplate SetCaptureFilePathTemplate;
};
union
{
// deprecated name
pRENDERDOC_GetLogFilePathTemplate GetLogFilePathTemplate;
// current name
pRENDERDOC_GetCaptureFilePathTemplate GetCaptureFilePathTemplate;
};
pRENDERDOC_GetNumCaptures GetNumCaptures;
pRENDERDOC_GetCapture GetCapture;
pRENDERDOC_TriggerCapture TriggerCapture;
// IsRemoteAccessConnected was renamed to IsTargetControlConnected in 1.1.1.
// This union allows old code to continue compiling without changes
union
{
// deprecated name
pRENDERDOC_IsRemoteAccessConnected IsRemoteAccessConnected;
// current name
pRENDERDOC_IsTargetControlConnected IsTargetControlConnected;
};
pRENDERDOC_LaunchReplayUI LaunchReplayUI;
pRENDERDOC_SetActiveWindow SetActiveWindow;
pRENDERDOC_StartFrameCapture StartFrameCapture;
pRENDERDOC_IsFrameCapturing IsFrameCapturing;
pRENDERDOC_EndFrameCapture EndFrameCapture;
// new function in 1.1.0
pRENDERDOC_TriggerMultiFrameCapture TriggerMultiFrameCapture;
// new function in 1.2.0
pRENDERDOC_SetCaptureFileComments SetCaptureFileComments;
// new function in 1.4.0
pRENDERDOC_DiscardFrameCapture DiscardFrameCapture;
// new function in 1.5.0
pRENDERDOC_ShowReplayUI ShowReplayUI;
// new function in 1.6.0
pRENDERDOC_SetCaptureTitle SetCaptureTitle;
// new functions in 1.7.0
pRENDERDOC_SetObjectAnnotation SetObjectAnnotation;
pRENDERDOC_SetCommandAnnotation SetCommandAnnotation;
} RENDERDOC_API_1_7_0;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_0_0;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_0_1;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_0_2;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_1_0;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_1_1;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_1_2;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_2_0;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_3_0;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_4_0;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_4_1;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_4_2;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_5_0;
typedef RENDERDOC_API_1_7_0 RENDERDOC_API_1_6_0;
//////////////////////////////////////////////////////////////////////////////////////////////////
// RenderDoc API entry point
//
// This entry point can be obtained via GetProcAddress/dlsym if RenderDoc is available.
//
// The name is the same as the typedef - "RENDERDOC_GetAPI"
//
// This function is not thread safe, and should not be called on multiple threads at once.
// Ideally, call this once as early as possible in your application's startup, before doing
// any API work, since some configuration functionality etc has to be done also before
// initialising any APIs.
//
// Parameters:
// version is a single value from the RENDERDOC_Version above.
//
// outAPIPointers will be filled out with a pointer to the corresponding struct of function
// pointers.
//
// Returns:
// 1 - if the outAPIPointers has been filled with a pointer to the API struct requested
// 0 - if the requested version is not supported or the arguments are invalid.
//
typedef int(RENDERDOC_CC *pRENDERDOC_GetAPI)(RENDERDOC_Version version, void **outAPIPointers);
#ifdef __cplusplus
} // extern "C"
#endif

6
lsfg-vk-common/include/lsfg-vk-common/vulkan/command_buffer.hpp
View file

@ -42,7 +42,8 @@ namespace vk {
void blitImage(const vk::Vulkan& vk,
const std::vector<vk::Barrier>& preBarriers,
std::pair<VkImage, VkImage> images, VkExtent2D extent,
const std::vector<vk::Barrier>& postBarriers) const;
const std::vector<vk::Barrier>& postBarriers,
uint32_t srcLayer = 0, uint32_t dstLayer = 0) const;
/// insert a bunch of barriers
/// @param vk the vulkan instance
@ -68,7 +69,8 @@ namespace vk {
/// @param buffer the source buffer
/// @param image the destination image
void copyBufferToImage(const vk::Vulkan& vk,
const vk::Buffer& buffer, const vk::Image& image) const;
const vk::Buffer& buffer, const vk::Image& image,
uint32_t dstLayer = 0) const;
/// end recording commands
/// @param vk the vulkan instance

5
lsfg-vk-common/include/lsfg-vk-common/vulkan/image.hpp
View file

@ -5,6 +5,7 @@
#include "../helpers/pointers.hpp"
#include "vulkan.hpp"
#include <cstdint>
#include <optional>
#include <vulkan/vulkan_core.h>
@ -26,7 +27,9 @@ namespace vk {
VkFormat format = VK_FORMAT_R8G8B8A8_UNORM,
VkImageUsageFlags usage = VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_SAMPLED_BIT,
std::optional<int> importFd = std::nullopt,
std::optional<int*> exportFd = std::nullopt);
std::optional<int*> exportFd = std::nullopt,
uint32_t arrayLayers = 1
);
/// get the image handle
/// @return the image handle

11
lsfg-vk-common/src/vulkan/command_buffer.cpp
View file

@ -105,7 +105,8 @@ void CommandBuffer::dispatch(const vk::Vulkan& vk,
void CommandBuffer::blitImage(const vk::Vulkan& vk,
const std::vector<vk::Barrier>& preBarriers,
std::pair<VkImage, VkImage> images, VkExtent2D extent,
const std::vector<vk::Barrier>& postBarriers) const {
const std::vector<vk::Barrier>& postBarriers,
uint32_t srcLayer, uint32_t dstLayer) const {
vk.df().CmdPipelineBarrier(*this->commandBuffer,
VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT, VK_PIPELINE_STAGE_TRANSFER_BIT,
0,
@ -117,7 +118,8 @@ void CommandBuffer::blitImage(const vk::Vulkan& vk,
const VkImageBlit region{
.srcSubresource = {
.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT,
.layerCount = 1
.baseArrayLayer = srcLayer,
.layerCount = 1,
},
.srcOffsets = {
{ 0, 0, 0 },
@ -126,6 +128,7 @@ void CommandBuffer::blitImage(const vk::Vulkan& vk,
},
.dstSubresource = {
.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT,
.baseArrayLayer = dstLayer,
.layerCount = 1
},
.dstOffsets = {
@ -151,7 +154,8 @@ void CommandBuffer::blitImage(const vk::Vulkan& vk,
}
void CommandBuffer::copyBufferToImage(const vk::Vulkan& vk,
const vk::Buffer& buffer, const vk::Image& image) const {
const vk::Buffer& buffer, const vk::Image& image,
uint32_t dstLayer) const {
const VkImageMemoryBarrier barrier{
.sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER,
.srcAccessMask = VK_ACCESS_NONE,
@ -179,6 +183,7 @@ void CommandBuffer::copyBufferToImage(const vk::Vulkan& vk,
.bufferImageHeight = 0,
.imageSubresource = {
.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT,
.baseArrayLayer = dstLayer,
.layerCount = 1
},
.imageExtent = {

21
lsfg-vk-common/src/vulkan/image.cpp
View file

@ -6,6 +6,7 @@
#include "lsfg-vk-common/vulkan/vulkan.hpp"
#include <bitset>
#include <cstdint>
#include <optional>
#include <vulkan/vulkan_core.h>
@ -16,7 +17,7 @@ namespace {
/// create a image
ls::owned_ptr<VkImage> createImage(const vk::Vulkan& vk,
VkExtent2D extent, VkFormat format, VkImageUsageFlags usage,
bool external) {
bool external, uint32_t arrayLayers) {
VkImage handle{};
const VkExternalMemoryImageCreateInfo externalInfo{
@ -34,7 +35,7 @@ namespace {
.depth = 1
},
.mipLevels = 1,
.arrayLayers = 1,
.arrayLayers = arrayLayers,
.samples = VK_SAMPLE_COUNT_1_BIT,
.usage = usage,
.sharingMode = VK_SHARING_MODE_EXCLUSIVE
@ -121,20 +122,20 @@ namespace {
}
/// create an image view
ls::owned_ptr<VkImageView> createImageView(const vk::Vulkan& vk,
VkImage image, VkFormat format) {
VkImage image, VkFormat format, uint32_t arrayLayers) {
VkImageView handle{};
const VkImageViewCreateInfo viewInfo{
.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO,
.image = image,
.viewType = VK_IMAGE_VIEW_TYPE_2D,
.viewType = arrayLayers == 1 ? VK_IMAGE_VIEW_TYPE_2D : VK_IMAGE_VIEW_TYPE_2D_ARRAY,
.format = format,
.subresourceRange = {
.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT,
.baseMipLevel = 0,
.levelCount = 1,
.baseArrayLayer = 0,
.layerCount = 1
.layerCount = arrayLayers
}
};
auto res = vk.df().CreateImageView(vk.dev(), &viewInfo, VK_NULL_HANDLE, &handle);
@ -155,10 +156,13 @@ Image::Image(const vk::Vulkan& vk,
VkFormat format,
VkImageUsageFlags usage,
std::optional<int> importFd,
std::optional<int*> exportFd) :
std::optional<int*> exportFd,
uint32_t arrayLayers
) :
image(createImage(vk,
extent, format, usage,
importFd.has_value() || exportFd.has_value()
importFd.has_value() || exportFd.has_value(),
arrayLayers
)),
memory(allocateMemory(vk,
*this->image,
@ -166,7 +170,8 @@ Image::Image(const vk::Vulkan& vk,
)),
view(createImageView(vk,
*this->image,
format
format,
arrayLayers
)),
extent(extent) {
}