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

Hello triangle sample: Replace deprecated debug reports extension, fix validation and clean up code #1199

Merged

Conversation

SaschaWillems
Copy link
Collaborator

@SaschaWillems SaschaWillems commented Oct 19, 2024

Description

The hello triangle sample has been using the debug report extension for validation, which has been deprecated years ago. This PR replaces that with the debug utils extension. It also fixes an issue where validation layers weren't enabled in debug builds unless explicitly requested via the VKB_VALIDATION_LAYERS cmake option. It also fixes some minor things like wrong/misleading error messges and does some general code cleanup like removing unnecessary variables and arguments.

This fixes one of the issues of that sample documented in #1168

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

@SaschaWillems SaschaWillems changed the title Replace deprecated debug reports extension and fix validation in Hello triangle sample Replace deprecated debug reports extension, fix validation in Hello triangle sample and some cleanup Oct 19, 2024
Use extension name constants instead of strings
Remove unnecessary arguments
@SaschaWillems SaschaWillems changed the title Replace deprecated debug reports extension, fix validation in Hello triangle sample and some cleanup Replace deprecated debug reports extension, fix validation in Hello triangle sample some code cleanup Oct 19, 2024
@SaschaWillems SaschaWillems changed the title Replace deprecated debug reports extension, fix validation in Hello triangle sample some code cleanup Hello triangle sample: Replace deprecated debug reports extension, fix validation and clean up code Oct 19, 2024
Copy link
Contributor

@asuessenbach asuessenbach left a comment

Choose a reason for hiding this comment

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

Substantially improves this sample.
Just one suggestion:

samples/api/hello_triangle/hello_triangle.cpp Show resolved Hide resolved
@marty-johnson59
Copy link
Contributor

3 approvals - merging

@marty-johnson59 marty-johnson59 merged commit 5b2bc1e into KhronosGroup:main Nov 13, 2024
23 checks passed
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.

5 participants