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

vk.xml: Include vk_platform type-header from vulkan/vk_platform.h #1538

Merged
merged 1 commit into from
Jun 27, 2021

Conversation

MarijnS95
Copy link
Contributor

It is generally expected that "top level" includes are relative to the ./include directory in this repo. The video headers, sitting at the root of the ./include folder in ./include/vk_video/vulkan_video_*.h, are listed as vk_video/vulkan_video_*.h in vk.xml. Likewise the vk_platform type-header is supposed to be listed as vulkan/vk_platform.h to match its relative location under ./include.

It is generally expected that "top level" includes are relative to the
`./include` directory in this repo.  The video headers, sitting at the
root of the `./include` folder in `./include/vk_video/vulkan_video_*.h`,
are listed as `vk_video/vulkan_video_*.h` in `vk.xml`.  Likewise the
`vk_platform` type-header is supposed to be listed as
`vulkan/vk_platform.h` to match its relative location under `./include`.
@CLAassistant
Copy link

CLAassistant commented May 25, 2021

CLA assistant check
All committers have signed the CLA.

@krOoze
Copy link
Contributor

krOoze commented May 27, 2021

That's pretty weird actually. I think vk_video/ should be vulkan/video/.

@MarijnS95
Copy link
Contributor Author

That's pretty weird actually. I think vk_video/ should be vulkan/video/.

I agree, created #1541 for it to track this separately for follow-up with the Video folks.

@oddhack oddhack added the Video Vulkan Video extensions label Jun 5, 2021
@oddhack oddhack added this to the Needs Approval milestone Jun 14, 2021
@oddhack
Copy link
Contributor

oddhack commented Jun 14, 2021

@zlatinski Video TSG should sign off on this one.

@MarijnS95
Copy link
Contributor Author

@oddhack I don't think vk_platform.h is solely related to Video, it's just the first occasion where we need access to Vulkan headers in addition to vk.xml and noticed this inconsistency.

@oddhack oddhack assigned TomOlson and unassigned zlatinski Jun 14, 2021
@oddhack
Copy link
Contributor

oddhack commented Jun 14, 2021

@oddhack I don't think vk_platform.h is solely related to Video, it's just the first occasion where we need access to Vulkan headers in addition to vk.xml and noticed this inconsistency.

OK. We'll take a look at it internally. It usually takes a lot of back-and-forthing between the different downstream components like the SDK before everyone signs off on even a simple change like this, so I wouldn't expect a quick response.

@oddhack
Copy link
Contributor

oddhack commented Jun 14, 2021

We talked about this briefly and are OK with taking it, but not until after next week's updates for internal scheduling reasons.

@MarijnS95
Copy link
Contributor Author

We talked about this briefly and are OK with taking it, but not until after next week's updates for internal scheduling reasons.

Great, thanks for that and thanks for keeping this issue updated!

@zlatinski
Copy link
Contributor

We are expecting Vulkan Video apps to add to the include paths both ..include/vk_video and ..include/vulkan, assuming the app is not using header file name spaces. The prefered way,, however, would be to only include the top level ../include path. The app, in this case should use the appropriate NS directories along with the included header file.
For example:
#include "vk_video/vulkan_video_codec_h264std_decode.h"
#include "vulkan/vulkan.h"

@MarijnS95
Copy link
Contributor Author

@zlatinski Totally, that makes the most sense. When looking at vk.xml that's already possible because it specifies vk_video/ as include path, but vk_platform.h still has to be moved as per this PR to enable that.

@oddhack oddhack merged commit c8621bf into KhronosGroup:main Jun 27, 2021
@MarijnS95 MarijnS95 deleted the vkxml-vk_platform-include branch June 28, 2021 08:07
MarijnS95 added a commit to ash-rs/ash that referenced this pull request Jun 29, 2021
MarijnS95 added a commit to ash-rs/ash that referenced this pull request Jun 29, 2021
MarijnS95 added a commit to ash-rs/ash that referenced this pull request Jun 29, 2021
MaikKlein pushed a commit to ash-rs/ash that referenced this pull request Jul 9, 2021
* generator: Fix Rust 1.53 clippy lints

* temporary: Allow bindgen nullptr dereference in layout tests

* Update Vulkan-Headers to 1.2.182

* extensions/ext: Add properties-getter for PhysicalDeviceDrmPropertiesEXT

* Update Vulkan-Headers to 1.2.183

* Remove upstream-fixed vk_platform.h header path fallback

Fixed in KhronosGroup/Vulkan-Docs#1538

* Update Vulkan-Headers to 1.2.184
oddhack added a commit that referenced this pull request Aug 16, 2021
This caused some issues with search paths per #1573. There will probably
be a downstream change to move the vk_video/ headers under
vulkan/vk_video instead of in a parallel directory. We are not entirely
settled on how to move this forward at the moment and there's a mix of
philosophical correctness and concrete build issues being discussed in
oddhack added a commit that referenced this pull request Aug 17, 2021
This caused some issues with search paths per #1573. There will probably
be a downstream change to move the vk_video/ headers under
vulkan/vk_video instead of in a parallel directory. We are not entirely
settled on how to move this forward at the moment and there's a mix of
philosophical correctness and concrete build issues being discussed in
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants