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

Transcoded version of api sample oit_depth_peeling based on Vulkan-Hpp #1038

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

Conversation

asuessenbach
Copy link
Contributor

Description

Introduces a new Vulkan-Hpp-based sample, which is a transcoded version of the oit_depth_peeling api sample.

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 asuessenbach marked this pull request as ready for review April 29, 2024 11:41
@asuessenbach asuessenbach requested a review from a team April 29, 2024 11:41
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.

I only took a look the documentation side of things, will test the sample itself later.

Aside from the image link, can you also add the translated sample to the navigation in nav.adoc?

samples/api/hpp_oit_depth_peeling/README.adoc Outdated Show resolved Hide resolved
@gary-sweet
Copy link
Contributor

Am I wrong in thinking that the "I did a full batch run using the batch command line argument" checkbox was added to ensure that the author of any change that touches the framework ran a batch test themselves before pushing a change for review?

I realize that this only has a small change to the framework, but surely just leaving the checkbox unchecked wasn't the intention when it was added.

@SaschaWillems
Copy link
Collaborator

SaschaWillems commented May 1, 2024

Exactly. That's what the checkbox is meant for (we discussed this during the last call). But the PR (#1025) that added this was merged prematurely and I have no way of reverting that. Right now batch mode will probably crash at some point as some samples still need to be fixed or until #1036 is merged.

@SaschaWillems SaschaWillems self-requested a review June 1, 2024 15:45
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.

Only a few minor documentation related comments.

Sample itself works fine for me, though I noticed some coloring differences between this and the non-hpp version. Nothing dramatic though.

@@ -90,6 +94,14 @@ A transcoded version of the API sample <<timestamp_queries,Timestamp queries>> t

Uses the instancing feature for rendering many instances of the same mesh from a single vertex buffer with variable parameters and textures.

=== xref:./{api_samplespath}oit_depth_peeling/README.adoc[OIT Depth Peeling]
Copy link
Collaborator

Choose a reason for hiding this comment

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

These two OIT samples are already listed here, see the end of the readme. This would be a duplicate.

ID ${FOLDER_NAME}
CATEGORY ${CATEGORY_NAME}
AUTHOR "Google"
NAME "hpp_oit_depth_peeling"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Since this is the name that's displayed on Android, it should be a proper name, see https://github.com/KhronosGroup/Vulkan-Samples/pull/1052/files

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

3 participants