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

Introduce type aliases for vkb::VulkanSample and vkb::core::VulkanResource. #1085

Merged
merged 2 commits into from
Jul 16, 2024

Conversation

asuessenbach
Copy link
Contributor

Description

Introduces type aliases VulkanSample[C|Cpp] and VulkanResource[C|Cpp].

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

If this PR contains framework changes:

  • I did a full batch run using the batch command line argument to make sure all samples still work properly

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
Copy link
Contributor Author

The "Initialize containers" step in the Clang Format Check fails!

No idea how to resolve that.

@SaschaWillems
Copy link
Collaborator

Either a downtime or something related to the current rework of Khronos CI. If this isn't working in a few hours, days, maybe ping James (Khronos Webmaster).

Copy link
Collaborator

@SaschaWillems SaschaWillems left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code changes look good to me.

But I think should also update the smaple templates to use the new aliases, see https://github.com/KhronosGroup/Vulkan-Samples/tree/main/bldsys/cmake/template/sample_api and https://github.com/KhronosGroup/Vulkan-Samples/tree/main/bldsys/cmake/template/sample

@asuessenbach
Copy link
Contributor Author

asuessenbach commented Jul 9, 2024

But I think should also update the smaple templates to use the new aliases, see https://github.com/KhronosGroup/Vulkan-Samples/tree/main/bldsys/cmake/template/sample_api and https://github.com/KhronosGroup/Vulkan-Samples/tree/main/bldsys/cmake/template/sample

Good point!

... and done.

@marty-johnson59
Copy link
Contributor

Merging per discussion yesterday. Thanks Gary!

@marty-johnson59 marty-johnson59 merged commit b115112 into KhronosGroup:main Jul 16, 2024
23 checks passed
@asuessenbach asuessenbach deleted the type_alias branch July 17, 2024 06:26
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

4 participants