Skip to content

Commit 7260a40

Browse files
committed
Fix sizeof's, add documentation for vulkan header
1 parent 9f55875 commit 7260a40

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

amf/public/include/core/VulkanAMF.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ namespace amf
5252

5353
typedef struct AMFVulkanSync
5454
{
55-
amf_size cbSizeof; // sizeof(AMFVulkanSemaphore)
55+
amf_size cbSizeof; // sizeof(AMFVulkanSync)
5656
void* pNext; // reserved for extensions
57-
VkSemaphore hSemaphore;
57+
VkSemaphore hSemaphore; // VkSemaphore; can be nullptr
5858
bool bSubmitted; // if true - wait for hSemaphore. re-submit hSemaphore if not synced by other ways and set to true
5959
VkFence hFence; // To sync on CPU; can be nullptr. Submitted in vkQueueSubmit. If waited for hFence, null it, do not delete or reset.
6060
} AMFVulkanSync;
@@ -78,12 +78,12 @@ namespace amf
7878
amf_size cbSizeof; // sizeof(AMFVulkanSurface)
7979
void* pNext; // reserved for extensions
8080
// surface properties
81-
VkImage hImage;
82-
VkDeviceMemory hMemory;
81+
VkImage hImage; // vulkan native image for which the surface is created
82+
VkDeviceMemory hMemory; // memory for hImage, can be nullptr
8383
amf_int64 iSize; // memory size
84-
amf_uint32 eFormat; // VkFormat
85-
amf_int32 iWidth;
86-
amf_int32 iHeight;
84+
amf_uint32 eFormat; // VkFormat; other properties (iWidth, iHeight) are asserted based on this
85+
amf_int32 iWidth; // image width
86+
amf_int32 iHeight; // image height
8787
amf_uint32 eCurrentLayout; // VkImageLayout
8888
amf_uint32 eUsage; // AMF_SURFACE_USAGE
8989
amf_uint32 eAccess; // AMF_MEMORY_CPU_ACCESS
@@ -92,7 +92,7 @@ namespace amf
9292

9393
typedef struct AMFVulkanView
9494
{
95-
amf_size cbSizeof; // sizeof(AMFVulkanSurface)
95+
amf_size cbSizeof; // sizeof(AMFVulkanView)
9696
void* pNext; // reserved for extensions
9797
// surface properties
9898
AMFVulkanSurface *pSurface;

0 commit comments

Comments
 (0)