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

cleanup on image layout transition functions #767

Merged

Conversation

asuessenbach
Copy link
Contributor

Description

Resolves validation layer warnings on using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT, which was the default for the set_image_layout helper function. Which actually was never used with different stages! And there was a helper function insert_image_memory_barrier, which did the exact same stuff.

Thus, introduced a set of helper functions image_layout_transition to cover this:

  • One version just taking the command buffer to record with, the image to transition its layout, and the old and new image layout. A default subresource range is used to call into the next overload of this function.
  • One version additionally taking a subresource range. The other flags are derived from the old and new image layout to form some meaningful set of flags. Then the next overload of this function is called.
  • One version additionally taking all the flags needed to form a valid transition.
  • One version taking a vector of images and subresource ranges. As above, the other flags are derived from the old and new image layout.

With this PR, all calls to set_image_layout and insert_image_memory_barrier are replaced by a call to one of the image_layout_transition routines, and those functions are removed. In addition, explicit calls to vkCmdPipelineBarrier with an image memory barrier are replaced by a call to image_layout_transition.

Compiled and tested on Win10, using 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 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

@asuessenbach asuessenbach force-pushed the image_layout_transition branch 2 times, most recently from da7c110 to 56da06a Compare August 1, 2023 08:56
@asuessenbach asuessenbach marked this pull request as ready for review August 1, 2023 10:32
@asuessenbach asuessenbach requested a review from a team August 1, 2023 10:33
tomadamatkinson
tomadamatkinson previously approved these changes Aug 8, 2023
Copy link
Collaborator

@tomadamatkinson tomadamatkinson left a comment

Choose a reason for hiding this comment

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

LGTM!

Liking that we are cleaning up api calls as well by replacing them with this simplified format

gpx1000
gpx1000 previously approved these changes Aug 14, 2023
@marty-johnson59 marty-johnson59 merged commit d97f58a into KhronosGroup:main Aug 14, 2023
23 checks passed
@asuessenbach asuessenbach deleted the image_layout_transition branch August 15, 2023 09:23
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.

4 participants