Skip to content

VulkanAMF.h documentation improvements #361

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 14, 2022
Merged

VulkanAMF.h documentation improvements #361

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7260a40
Fix sizeof's, add documentation for vulkan header
blaind Oct 23, 2022
2102d1b
Clean up comment
rhutsAMD Nov 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions amf/public/include/core/VulkanAMF.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ namespace amf

typedef struct AMFVulkanSync
{
amf_size cbSizeof; // sizeof(AMFVulkanSemaphore)
amf_size cbSizeof; // sizeof(AMFVulkanSync)
void* pNext; // reserved for extensions
VkSemaphore hSemaphore;
VkSemaphore hSemaphore; // VkSemaphore; can be nullptr
bool bSubmitted; // if true - wait for hSemaphore. re-submit hSemaphore if not synced by other ways and set to true
VkFence hFence; // To sync on CPU; can be nullptr. Submitted in vkQueueSubmit. If waited for hFence, null it, do not delete or reset.
} AMFVulkanSync;
Expand All @@ -78,12 +78,12 @@ namespace amf
amf_size cbSizeof; // sizeof(AMFVulkanSurface)
void* pNext; // reserved for extensions
// surface properties
VkImage hImage;
VkDeviceMemory hMemory;
VkImage hImage; // vulkan native image for which the surface is created
VkDeviceMemory hMemory; // memory for hImage, can be nullptr
amf_int64 iSize; // memory size
amf_uint32 eFormat; // VkFormat
amf_int32 iWidth;
amf_int32 iHeight;
amf_int32 iWidth; // image width
amf_int32 iHeight; // image height
amf_uint32 eCurrentLayout; // VkImageLayout
amf_uint32 eUsage; // AMF_SURFACE_USAGE
amf_uint32 eAccess; // AMF_MEMORY_CPU_ACCESS
Expand All @@ -92,7 +92,7 @@ namespace amf

typedef struct AMFVulkanView
{
amf_size cbSizeof; // sizeof(AMFVulkanSurface)
amf_size cbSizeof; // sizeof(AMFVulkanView)
void* pNext; // reserved for extensions
// surface properties
AMFVulkanSurface *pSurface;
Expand Down