Skip to content
New issue

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

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

Unify vkb::Subpass and vkb::rendering::HPPSubpass into vkb::rendering::Subpass<bindingType> #1035

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

asuessenbach
Copy link
Contributor

Description

Build tested on Win10 with VS2022. Run tested on Win10 with NVidia GPU.

General Checklist:

Please ensure the following points are checked:

  • My code follows the coding style
  • I have reviewed file licenses
  • I have commented any added functions (in line with Doxygen)
  • I have commented any code that could be hard to understand
  • My changes do not add any new compiler warnings
  • My changes do not add any new validation layer errors or warnings
  • I have used existing framework/helper functions where possible
  • My changes do not add any regressions
  • I have tested every sample to ensure everything runs correctly
  • This PR describes the scope and expected impact of the changes I am making

Note: The Samples CI runs a number of checks including:

  • I have updated the header Copyright to reflect the current year (CI build will fail if Copyright is out of date)
  • My changes build on Windows, Linux, macOS and Android. Otherwise I have documented any exceptions

Sample Checklist

If your PR contains a new or modified sample, these further checks must be carried out in addition to the General Checklist:

  • I have tested the sample on at least one compliant Vulkan implementation
  • If the sample is vendor-specific, I have tagged it appropriately
  • I have stated on what implementation the sample has been tested so that others can test on different implementations and platforms
  • Any dependent assets have been merged and published in downstream modules
  • For new samples, I have added a paragraph with a summary to the appropriate chapter in the readme of the folder that the sample belongs to e.g. api samples readme
  • For new samples, I have added a tutorial README.md file to guide users through what they need to know to implement code using this feature. For example, see conditional_rendering
  • For new samples, I have added a link to the Antora navigation so that the sample will be listed at the Vulkan documentation site

@asuessenbach asuessenbach marked this pull request as ready for review April 25, 2024 06:31
@asuessenbach asuessenbach requested a review from a team April 25, 2024 06:31
@SaschaWillems
Copy link
Collaborator

SaschaWillems commented Apr 25, 2024

This does work fine for me (tested a few samples with the batch run), but I',m kinda unsure about the actual interface.

Once we have unified the repo will we have to add the binding type to each and every class from the framework? If so, I fear that this will make the code hard to read.

e.g. comparing this:

std::vector<std::unique_ptr<vkb::Subpass>> subpasses{};

with:

std::vector<std::unique_ptr<vkb::rendering::Subpass<vkb::BindingType::C>>> subpasses{};

Imo readability suffers a lot. Is it possible to somehow omit the binding type unless one explicitly wants to use the CPP variants?

@asuessenbach
Copy link
Contributor Author

I agree, the resulting types are somewhat longer than before.

  • I moved the class Subpass from namespace vkb to vkb::rendering, to make it clear where it resides. If it's consensus that that is a bad move, it would be easy to revert that.
  • In order to have the very same class work for both, the C- and the C++-bindings, that BindingType template parameter is added. It is needed. One could, though, add some type aliases like
using SubpassC   = Subpass<vkb::BindingType::C>;
using SubpassCpp = Subpass<vkb::BindingType::Cpp>;

which would reduce the aforementioned complexity a bit:
std::vector<std::unique_ptr<vkb::rendering::SubpassC>> subpasses{};
If it's consensus, I could easily add something like that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants