Browse Source

doc: forgot to list this Vulkan API.

... and Doxygen is shitty once again, totally ignoring the doc block on
a forward declaration. FFS.
pull/491/head
Vladimír Vondruš 6 years ago
parent
commit
4b7b74715d
  1. 2
      doc/vulkan-mapping.dox
  2. 18
      src/Magnum/Vk/Memory.h

2
doc/vulkan-mapping.dox

@ -231,7 +231,7 @@ Vulkan function | Matching API
Vulkan function | Matching API Vulkan function | Matching API
--------------------------------------- | ------------ --------------------------------------- | ------------
@fn_vk{MapMemory}, \n @fn_vk{UnmapMemory} | | @fn_vk{MapMemory}, \n @fn_vk{UnmapMemory} | @ref Memory::map(), @ref MemoryMapDeleter
@fn_vk{MergePipelineCaches} | | @fn_vk{MergePipelineCaches} | |
@subsection vulkan-mapping-functions-q Q @subsection vulkan-mapping-functions-q Q

18
src/Magnum/Vk/Memory.h

@ -39,13 +39,6 @@
namespace Magnum { namespace Vk { namespace Magnum { namespace Vk {
/** @relates Memory
@brief Deleter for mapped memory
@m_since_latest
Deleter for the array returned from @ref Memory::map(). Calls
@fn_vk_keyword{UnmapMemory}.
*/
class MemoryMapDeleter; class MemoryMapDeleter;
/** /**
@ -453,8 +446,15 @@ class MAGNUM_VK_EXPORT Memory {
UnsignedLong _size; UnsignedLong _size;
}; };
#ifndef DOXYGEN_GENERATING_OUTPUT /** @relates Memory
@brief Deleter for mapped memory
@m_since_latest
Deleter for the array returned from @ref Memory::map(). Calls
@fn_vk_keyword{UnmapMemory}.
*/
class MAGNUM_VK_EXPORT MemoryMapDeleter { class MAGNUM_VK_EXPORT MemoryMapDeleter {
#ifndef DOXYGEN_GENERATING_OUTPUT
public: public:
explicit MemoryMapDeleter(): _unmap{}, _device{}, _memory{} {} explicit MemoryMapDeleter(): _unmap{}, _device{}, _memory{} {}
explicit MemoryMapDeleter(void(*unmap)(VkDevice, VkDeviceMemory), VkDevice device, VkDeviceMemory memory): _unmap{unmap}, _device{device}, _memory{memory} {} explicit MemoryMapDeleter(void(*unmap)(VkDevice, VkDeviceMemory), VkDevice device, VkDeviceMemory memory): _unmap{unmap}, _device{device}, _memory{memory} {}
@ -466,8 +466,8 @@ class MAGNUM_VK_EXPORT MemoryMapDeleter {
void(*_unmap)(VkDevice, VkDeviceMemory); void(*_unmap)(VkDevice, VkDeviceMemory);
VkDevice _device; VkDevice _device;
VkDeviceMemory _memory; VkDeviceMemory _memory;
#endif
}; };
#endif
}} }}

Loading…
Cancel
Save