Skip to content

Unify vkb::RenderContext and vkb::rendering::HPPRenderContext into vkb::rendering::RenderContext<bindingType> #1410

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
marty-johnson59 merged 1 commit into from
Oct 6, 2025
Merged

Unify vkb::RenderContext and vkb::rendering::HPPRenderContext into vkb::rendering::RenderContext<bindingType> #1410

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
5 changes: 3 additions & 2 deletions app/plugins/screenshot/screenshot.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
#include <chrono>
#include <iomanip>

#include "common/utils.h"
#include "rendering/render_context.h"

namespace plugins
Expand Down Expand Up @@ -79,7 +80,7 @@ void Screenshot::on_app_start(const std::string &name)
current_frame = 0;
}

void Screenshot::on_post_draw(vkb::RenderContext &context)
void Screenshot::on_post_draw(vkb::rendering::RenderContextC &context)
{
if (current_frame == frame_number)
{
Expand All @@ -99,7 +100,7 @@ void Screenshot::on_post_draw(vkb::RenderContext &context)
output_path = stream.str();
}

screenshot(context, output_path);
vkb::screenshot(context, output_path);
}
}
} // namespace plugins
2 changes: 1 addition & 1 deletion app/plugins/screenshot/screenshot.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class Screenshot : public ScreenshotTags

void on_update(float delta_time) override;
void on_app_start(const std::string &app_info) override;
void on_post_draw(vkb::RenderContext &context) override;
void on_post_draw(vkb::rendering::RenderContextC &context) override;

bool handle_option(std::deque<std::string> &arguments) override;

Expand Down
3 changes: 0 additions & 3 deletions framework/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ set(RENDERING_FILES
rendering/render_target.h
rendering/subpass.h
rendering/hpp_pipeline_state.h
rendering/hpp_render_context.h
rendering/hpp_render_pipeline.h
rendering/hpp_render_target.h
# Source files
Expand All @@ -119,10 +118,8 @@ set(RENDERING_FILES
rendering/postprocessing_pass.cpp
rendering/postprocessing_renderpass.cpp
rendering/postprocessing_computepass.cpp
rendering/render_context.cpp
rendering/render_pipeline.cpp
rendering/render_target.cpp
rendering/hpp_render_context.cpp
rendering/hpp_render_target.cpp)

set(RENDERING_SUBPASSES_FILES
Expand Down
12 changes: 5 additions & 7 deletions framework/common/hpp_utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Copyright (c) 2021-2024, NVIDIA CORPORATION. All rights reserved.
/* Copyright (c) 2021-2025, NVIDIA CORPORATION. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*
Expand All @@ -17,10 +17,8 @@

#pragma once

#include <common/utils.h>

#include <rendering/hpp_render_context.h>
#include <scene_graph/hpp_scene.h>
#include "common/utils.h"
#include "scene_graph/hpp_scene.h"

/**
* @brief facade helper functions around the functions in common/utils.h, providing a vulkan.hpp-based interface
Expand All @@ -34,9 +32,9 @@ inline sg::Node &add_free_camera(vkb::scene_graph::HPPScene &scene, const std::s
return vkb::add_free_camera(reinterpret_cast<vkb::sg::Scene &>(scene), node_name, static_cast<VkExtent2D>(extent));
}

inline void screenshot(vkb::rendering::HPPRenderContext &render_context, const std::string &filename)
inline void screenshot(vkb::rendering::RenderContextCpp &render_context, const std::string &filename)
{
vkb::screenshot(reinterpret_cast<vkb::RenderContext &>(render_context), filename);
vkb::screenshot(reinterpret_cast<vkb::rendering::RenderContextC &>(render_context), filename);
}
} // namespace common
} // namespace vkb
10 changes: 10 additions & 0 deletions framework/common/hpp_vk_common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,16 @@ inline vk::Format choose_blendable_format(vk::PhysicalDevice gpu, const std::vec
throw std::runtime_error("No suitable blendable format could be determined");
}

inline vk::ImageCompressionPropertiesEXT query_applied_compression(vk::Device device, vk::Image image)
{
vk::ImageSubresource2EXT image_subresource{
.imageSubresource = {.aspectMask = vk::ImageAspectFlagBits::eColor, .mipLevel = 0, .arrayLayer = 0}};

auto imageSubresourceLayout = device.getImageSubresourceLayout2EXT<vk::SubresourceLayout2EXT, vk::ImageCompressionPropertiesEXT>(image, image_subresource);

return imageSubresourceLayout.get<vk::ImageCompressionPropertiesEXT>();
}

// helper functions not backed by vk_common.h
inline vk::CommandBuffer
allocate_command_buffer(vk::Device device, vk::CommandPool command_pool, vk::CommandBufferLevel level = vk::CommandBufferLevel::ePrimary)
Expand Down
4 changes: 3 additions & 1 deletion framework/common/utils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
#include <queue>
#include <stdexcept>

#include "core/command_buffer.h"
#include "rendering/render_frame.h"
#include "scene_graph/components/material.h"
#include "scene_graph/components/perspective_camera.h"
#include "scene_graph/components/sub_mesh.h"
Expand All @@ -40,7 +42,7 @@ std::string get_extension(const std::string &uri)
return uri.substr(dot_pos + 1);
}

void screenshot(RenderContext &render_context, const std::string &filename)
void screenshot(vkb::rendering::RenderContextC &render_context, const std::string &filename)
{
assert(render_context.get_format() == VK_FORMAT_R8G8B8A8_UNORM ||
render_context.get_format() == VK_FORMAT_B8G8R8A8_UNORM ||
Expand Down
2 changes: 1 addition & 1 deletion framework/common/utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ std::string to_snake_case(const std::string &name);
* @param render_context The RenderContext to use
* @param filename The name of the file to save the output to
*/
void screenshot(RenderContext &render_context, const std::string &filename);
void screenshot(vkb::rendering::RenderContextC &render_context, const std::string &filename);

/**
* @brief Adds a light to the scene with the specified parameters
Expand Down
1 change: 1 addition & 0 deletions framework/core/command_buffer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
#include "rendering/hpp_pipeline_state.h"
#include "rendering/hpp_render_target.h"
#include "rendering/subpass.h"
#include "resource_cache.h"

namespace vkb
{
Expand Down
176 changes: 141 additions & 35 deletions framework/core/hpp_swapchain.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ constexpr const T &clamp(const T &v, const T &lo, const T &hi)
return (v < lo) ? lo : ((hi < v) ? hi : v);
}

inline uint32_t choose_image_count(uint32_t request_image_count, uint32_t min_image_count, uint32_t max_image_count)
{
return clamp(request_image_count, min_image_count, (max_image_count != 0) ? max_image_count : request_image_count);
}

vk::Extent2D choose_extent(vk::Extent2D request_extent,
const vk::Extent2D &min_image_extent,
const vk::Extent2D &max_image_extent,
Expand Down Expand Up @@ -111,6 +116,11 @@ vk::SurfaceFormatKHR choose_surface_format(const vk::SurfaceFormatKHR
}
}

inline uint32_t choose_image_array_layers(uint32_t request_image_array_layers, uint32_t max_image_array_layers)
{
return clamp(request_image_array_layers, 1u, max_image_array_layers);
}

vk::SurfaceTransformFlagBitsKHR choose_transform(vk::SurfaceTransformFlagBitsKHR request_transform,
vk::SurfaceTransformFlagsKHR supported_transform,
vk::SurfaceTransformFlagBitsKHR current_transform)
Expand Down Expand Up @@ -221,7 +231,8 @@ vk::ImageUsageFlags composite_image_flags(std::set<vk::ImageUsageFlagBits> &imag
namespace core
{
HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain, const vk::Extent2D &extent) :
HPPSwapchain{old_swapchain.device,
HPPSwapchain{old_swapchain,
old_swapchain.device,
old_swapchain.surface,
old_swapchain.properties.present_mode,
old_swapchain.present_mode_priority_list,
Expand All @@ -230,11 +241,13 @@ HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain, const vk::Extent2D &exte
old_swapchain.properties.image_count,
old_swapchain.properties.pre_transform,
old_swapchain.image_usage_flags,
old_swapchain.get_handle()}
old_swapchain.requested_compression,
old_swapchain.requested_compression_fixed_rate}
{}

HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain, const uint32_t image_count) :
HPPSwapchain{old_swapchain.device,
HPPSwapchain{old_swapchain,
old_swapchain.device,
old_swapchain.surface,
old_swapchain.properties.present_mode,
old_swapchain.present_mode_priority_list,
Expand All @@ -243,11 +256,13 @@ HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain, const uint32_t image_cou
image_count,
old_swapchain.properties.pre_transform,
old_swapchain.image_usage_flags,
old_swapchain.get_handle()}
old_swapchain.requested_compression,
old_swapchain.requested_compression_fixed_rate}
{}

HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain, const std::set<vk::ImageUsageFlagBits> &image_usage_flags) :
HPPSwapchain{old_swapchain.device,
HPPSwapchain{old_swapchain,
old_swapchain.device,
old_swapchain.surface,
old_swapchain.properties.present_mode,
old_swapchain.present_mode_priority_list,
Expand All @@ -256,11 +271,13 @@ HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain, const std::set<vk::Image
old_swapchain.properties.image_count,
old_swapchain.properties.pre_transform,
image_usage_flags,
old_swapchain.get_handle()}
old_swapchain.requested_compression,
old_swapchain.requested_compression_fixed_rate}
{}

HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain, const vk::Extent2D &extent, const vk::SurfaceTransformFlagBitsKHR transform) :
HPPSwapchain{old_swapchain.device,
HPPSwapchain{old_swapchain,
old_swapchain.device,
old_swapchain.surface,
old_swapchain.properties.present_mode,
old_swapchain.present_mode_priority_list,
Expand All @@ -269,21 +286,58 @@ HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain, const vk::Extent2D &exte
old_swapchain.properties.image_count,
transform,
old_swapchain.image_usage_flags,
old_swapchain.get_handle()}
old_swapchain.requested_compression,
old_swapchain.requested_compression_fixed_rate}
{}

HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain,
const vk::ImageCompressionFlagsEXT requested_compression,
const vk::ImageCompressionFixedRateFlagsEXT requested_compression_fixed_rate) :
HPPSwapchain{old_swapchain,
old_swapchain.device,
old_swapchain.surface,
old_swapchain.properties.present_mode,
old_swapchain.present_mode_priority_list,
old_swapchain.surface_format_priority_list,
old_swapchain.properties.extent,
old_swapchain.properties.image_count,
old_swapchain.properties.pre_transform,
old_swapchain.image_usage_flags,
requested_compression,
requested_compression_fixed_rate}
{
}

HPPSwapchain::HPPSwapchain(vkb::core::DeviceCpp &device,
vk::SurfaceKHR surface,
const vk::PresentModeKHR present_mode,
const std::vector<vk::PresentModeKHR> &present_mode_priority_list,
const std::vector<vk::SurfaceFormatKHR> &surface_format_priority_list,
const vk::Extent2D &extent,
const uint32_t image_count,
const vk::SurfaceTransformFlagBitsKHR transform,
const std::set<vk::ImageUsageFlagBits> &image_usage_flags,
const vk::ImageCompressionFlagsEXT requested_compression,
const vk::ImageCompressionFixedRateFlagsEXT requested_compression_fixed_rate) :
HPPSwapchain{*this, device, surface, present_mode, present_mode_priority_list, surface_format_priority_list, extent, image_count, transform, image_usage_flags}
{}

HPPSwapchain::HPPSwapchain(vkb::core::DeviceCpp &device,
vk::SurfaceKHR surface,
const vk::PresentModeKHR present_mode,
const std::vector<vk::PresentModeKHR> &present_mode_priority_list,
const std::vector<vk::SurfaceFormatKHR> &surface_format_priority_list,
const vk::Extent2D &extent,
const uint32_t image_count,
const vk::SurfaceTransformFlagBitsKHR transform,
const std::set<vk::ImageUsageFlagBits> &image_usage_flags,
vk::SwapchainKHR old_swapchain) :
HPPSwapchain::HPPSwapchain(HPPSwapchain &old_swapchain,
vkb::core::DeviceCpp &device,
vk::SurfaceKHR surface,
const vk::PresentModeKHR present_mode,
std::vector<vk::PresentModeKHR> const &present_mode_priority_list,
const std::vector<vk::SurfaceFormatKHR> &surface_format_priority_list,
const vk::Extent2D &extent,
const uint32_t image_count,
const vk::SurfaceTransformFlagBitsKHR transform,
const std::set<vk::ImageUsageFlagBits> &image_usage_flags,
const vk::ImageCompressionFlagsEXT requested_compression,
const vk::ImageCompressionFixedRateFlagsEXT requested_compression_fixed_rate) :
device{device},
surface{surface}
surface{surface},
requested_compression{requested_compression},
requested_compression_fixed_rate{requested_compression_fixed_rate}
{
this->present_mode_priority_list = present_mode_priority_list;
this->surface_format_priority_list = surface_format_priority_list;
Expand All @@ -305,13 +359,11 @@ HPPSwapchain::HPPSwapchain(vkb::core::DeviceCpp &device,
// Choose best properties based on surface capabilities
vk::SurfaceCapabilitiesKHR const surface_capabilities = device.get_gpu().get_handle().getSurfaceCapabilitiesKHR(surface);

properties.old_swapchain = old_swapchain;
properties.image_count = clamp(image_count,
surface_capabilities.minImageCount,
surface_capabilities.maxImageCount ? surface_capabilities.maxImageCount : std::numeric_limits<uint32_t>::max());
properties.old_swapchain = old_swapchain.get_handle();
properties.image_count = choose_image_count(image_count, surface_capabilities.minImageCount, surface_capabilities.maxImageCount);
properties.extent = choose_extent(extent, surface_capabilities.minImageExtent, surface_capabilities.maxImageExtent, surface_capabilities.currentExtent);
properties.surface_format = choose_surface_format(properties.surface_format, surface_formats, surface_format_priority_list);
properties.array_layers = 1;
properties.array_layers = choose_image_array_layers(1U, surface_capabilities.maxImageArrayLayers);

vk::FormatProperties const format_properties = device.get_gpu().get_handle().getFormatProperties(properties.surface_format.format);
this->image_usage_flags = choose_image_usage(image_usage_flags, surface_capabilities.supportedUsageFlags, format_properties.optimalTilingFeatures);
Expand All @@ -321,21 +373,75 @@ HPPSwapchain::HPPSwapchain(vkb::core::DeviceCpp &device,
properties.composite_alpha = choose_composite_alpha(vk::CompositeAlphaFlagBitsKHR::eInherit, surface_capabilities.supportedCompositeAlpha);
properties.present_mode = choose_present_mode(present_mode, present_modes, present_mode_priority_list);

vk::SwapchainCreateInfoKHR const create_info{.surface = surface,
.minImageCount = properties.image_count,
.imageFormat = properties.surface_format.format,
.imageColorSpace = properties.surface_format.colorSpace,
.imageExtent = properties.extent,
.imageArrayLayers = properties.array_layers,
.imageUsage = properties.image_usage,
.preTransform = properties.pre_transform,
.compositeAlpha = properties.composite_alpha,
.presentMode = properties.present_mode,
.oldSwapchain = properties.old_swapchain};
vk::SwapchainCreateInfoKHR create_info{.surface = surface,
.minImageCount = properties.image_count,
.imageFormat = properties.surface_format.format,
.imageColorSpace = properties.surface_format.colorSpace,
.imageExtent = properties.extent,
.imageArrayLayers = properties.array_layers,
.imageUsage = properties.image_usage,
.preTransform = properties.pre_transform,
.compositeAlpha = properties.composite_alpha,
.presentMode = properties.present_mode,
.oldSwapchain = properties.old_swapchain};

auto fixed_rate_flags = requested_compression_fixed_rate;
vk::ImageCompressionControlEXT compression_control;
compression_control.flags = requested_compression;
if (device.is_extension_enabled(VK_EXT_IMAGE_COMPRESSION_CONTROL_SWAPCHAIN_EXTENSION_NAME))
{
create_info.pNext = &compression_control;

if (vk::ImageCompressionFlagBitsEXT::eFixedRateExplicit == requested_compression)
{
// Do not support compression for multi-planar formats
compression_control.compressionControlPlaneCount = 1;
compression_control.pFixedRateFlags = &fixed_rate_flags;
}
else if (vk::ImageCompressionFlagBitsEXT::eDisabled == requested_compression)
{
LOGW("(Swapchain) Disabling default (lossless) compression, which can negatively impact performance")
}
}
else
{
if (vk::ImageCompressionFlagBitsEXT::eDefault != requested_compression)
{
LOGW("(Swapchain) Compression cannot be controlled because VK_EXT_image_compression_control_swapchain is not enabled")

this->requested_compression = vk::ImageCompressionFlagBitsEXT::eDefault;
this->requested_compression_fixed_rate = vk::ImageCompressionFixedRateFlagBitsEXT::eNone;
}
}

handle = device.get_handle().createSwapchainKHR(create_info);

images = device.get_handle().getSwapchainImagesKHR(handle);

if (device.is_extension_enabled(VK_EXT_IMAGE_COMPRESSION_CONTROL_SWAPCHAIN_EXTENSION_NAME) &&
vk::ImageCompressionFlagBitsEXT::eFixedRateDefault == requested_compression)
{
// Check if fixed-rate compression was applied
const auto applied_compression_fixed_rate = vkb::common::query_applied_compression(device.get_handle(), images[0]).imageCompressionFixedRateFlags;

if (applied_compression_fixed_rate != requested_compression_fixed_rate)
{
LOGW("(Swapchain) Requested fixed-rate compression ({}) was not applied, instead images use {}",
vk::to_string(requested_compression_fixed_rate),
vk::to_string(applied_compression_fixed_rate));

this->requested_compression_fixed_rate = applied_compression_fixed_rate;

if (vk::ImageCompressionFixedRateFlagBitsEXT::eNone == applied_compression_fixed_rate)
{
this->requested_compression = vk::ImageCompressionFlagBitsEXT::eDefault;
}
}
else
{
LOGI("(Swapchain) Applied fixed-rate compression: {}", vk::to_string(applied_compression_fixed_rate));
}
}
}

HPPSwapchain::~HPPSwapchain()
Expand Down
Loading
Loading