Browse Source

Vk: doc++

Buncha brainfarts in there.
pull/494/head
Vladimír Vondruš 5 years ago
parent
commit
f438199b7a
  1. 2
      doc/vulkan-mapping.dox
  2. 7
      src/Magnum/Vk/Device.h
  3. 2
      src/Magnum/Vk/DeviceCreateInfo.h
  4. 2
      src/Magnum/Vk/DeviceFeatures.h
  5. 6
      src/Magnum/Vk/Instance.h
  6. 6
      src/Magnum/Vk/InstanceCreateInfo.h
  7. 1
      src/Magnum/Vk/Memory.h
  8. 1
      src/Magnum/Vk/MemoryAllocateInfo.h
  9. 5
      src/Magnum/Vk/PixelFormat.h
  10. 1
      src/Magnum/Vk/RenderPass.h
  11. 1
      src/Magnum/Vk/RenderPassCreateInfo.h

2
doc/vulkan-mapping.dox

@ -938,7 +938,7 @@ Vulkan enum | Matching API
@type_vk{QueryPipelineStatisticFlagBits}, \n @type_vk{QueryPipelineStatisticFlags} | |
@type_vk{QueryResultFlagBits}, \n @type_vk{QueryResultFlags} | |
@type_vk{QueryType} | |
@type_vk{QueueFlagBits}, \n @type_vk{QueueFlags} | |
@type_vk{QueueFlagBits}, \n @type_vk{QueueFlags} | @ref QueueFlag, \n @ref QueueFlags
@subsection vulkan-mapping-enums-r R

7
src/Magnum/Vk/Device.h

@ -423,8 +423,8 @@ class MAGNUM_VK_EXPORT Device {
* @snippet MagnumVk.cpp Device-isExtensionEnabled
*
* Note that this returns @cpp true @ce only if given extension is
* supported by the driver *and* it was enabled in
* @ref DeviceCreateInfo when creating the @ref Device. For querying
* supported by the driver *and* it was enabled via
* @ref DeviceCreateInfo::addEnabledExtensions(). For querying
* extension support before creating a device use
* @ref ExtensionProperties::isSupported().
*/
@ -439,7 +439,8 @@ class MAGNUM_VK_EXPORT Device {
/**
* @brief Features enabled on the device
*
* @see @ref DeviceProperties::features()
* @see @ref DeviceCreateInfo::setEnabledFeatures(),
* @ref DeviceProperties::features()
*/
const DeviceFeatures& enabledFeatures() const { return _enabledFeatures; }

2
src/Magnum/Vk/DeviceCreateInfo.h

@ -176,7 +176,7 @@ class MAGNUM_VK_EXPORT DeviceCreateInfo {
* or in at least one of the enabled layers, use
* @ref ExtensionProperties::isSupported() to check for their presence.
*
* The function makes copies of string views that are not owning or
* The function makes copies of string views that are not global or
* null-terminated, use the @link Containers::Literals::operator""_s() @endlink
* literal to prevent that where possible.
*/

2
src/Magnum/Vk/DeviceFeatures.h

@ -46,7 +46,7 @@ Contains information stored in the @type_vk_keyword{PhysicalDeviceFeatures2}
structure chain. Values correspond to equivalently named structure fields,
usually just with the first letter uppercase instead of lowercase.
@see @ref DeviceFeatures, @ref DeviceProperties::features(),
@ref Device::enabledFeatures()
@ref DeviceCreateInfo::setEnabledFeatures(), @ref Device::enabledFeatures()
@todo @type_vk{PhysicalDeviceVulkan12Features} additionally has
`samplerMirrorClampToEdge`, `drawIndirectCount`, `descriptorIndexing`,

6
src/Magnum/Vk/Instance.h

@ -371,9 +371,9 @@ class MAGNUM_VK_EXPORT Instance {
* @snippet MagnumVk.cpp Instance-isExtensionEnabled
*
* Note that this returns @cpp true @ce only if given extension is
* supported by the driver *and* it was enabled in
* @ref InstanceCreateInfo when creating the @ref Instance. For
* querying extension support before creating an instance use
* supported by the driver *and* it was enabled via
* @ref InstanceCreateInfo::addEnabledExtensions(). For querying
* extension support before creating an instance use
* @ref InstanceExtensionProperties::isSupported().
*/
template<class E> bool isExtensionEnabled() const {

6
src/Magnum/Vk/InstanceCreateInfo.h

@ -156,7 +156,7 @@ class MAGNUM_VK_EXPORT InstanceCreateInfo {
* Use the @ref version() helper to create the @p version value. The
* name is @cpp nullptr @ce by default.
*
* The function makes copies of string views that are not owning or
* The function makes copies of string views that are not global or
* null-terminated, use the @link Containers::Literals::operator""_s() @endlink
* literal to prevent that where possible.
*/
@ -172,7 +172,7 @@ class MAGNUM_VK_EXPORT InstanceCreateInfo {
* @ref Vk-Instance-command-line "command-line options", it's not
* added.
*
* The function makes copies of string views that are not owning or
* The function makes copies of string views that are not global or
* null-terminated, use the @link Containers::Literals::operator""_s() @endlink
* literal to prevent that where possible.
*/
@ -192,7 +192,7 @@ class MAGNUM_VK_EXPORT InstanceCreateInfo {
* @ref Vk-Instance-command-line "command-line options", it's not
* added.
*
* The function makes copies of string views that are not owning or
* The function makes copies of string views that are not global or
* null-terminated, use the @link Containers::Literals::operator""_s() @endlink
* literal to prevent that where possible.
*/

1
src/Magnum/Vk/Memory.h

@ -27,6 +27,7 @@
/** @file
* @brief Class @ref Magnum::Vk::MemoryRequirements, @ref Magnum::Vk::MemoryAllocateInfo, @ref Magnum::Vk::Memory, enum @ref Magnum::Vk::MemoryFlag, enum set @ref Magnum::Vk::MemoryFlags
* @m_since_latest
*/
#include <Corrade/Containers/EnumSet.h>

1
src/Magnum/Vk/MemoryAllocateInfo.h

@ -27,6 +27,7 @@
/** @file
* @brief Class @ref Magnum::Vk::MemoryRequirements, @ref Magnum::Vk::MemoryAllocateInfo
* @m_since_latest
*/
#include "Magnum/Magnum.h"

5
src/Magnum/Vk/PixelFormat.h

@ -1394,7 +1394,10 @@ enum class PixelFormat: Int {
CompressedPvrtc2RGBA4bppSrgb = VK_FORMAT_PVRTC2_4BPP_SRGB_BLOCK_IMG
};
/** @debugoperatorenum{PixelFormat} */
/**
@debugoperatorenum{PixelFormat}
@m_since_latest
*/
MAGNUM_VK_EXPORT Debug& operator<<(Debug& debug, PixelFormat value);
/**

1
src/Magnum/Vk/RenderPass.h

@ -27,6 +27,7 @@
/** @file
* @brief Class @ref Magnum::Vk::RenderPass, @ref Magnum::Vk::RenderPassBeginInfo, @ref Magnum::Vk::SubpassBeginInfo, @ref Magnum::Vk::SubpassEndInfo, enum @ref Magnum::Vk::SubpassContents
* @m_since_latest
*/
#include <Corrade/Containers/Pointer.h>

1
src/Magnum/Vk/RenderPassCreateInfo.h

@ -27,6 +27,7 @@
/** @file
* @brief Class @ref Magnum::Vk::AttachmentDescription, @ref Magnum::Vk::AttachmentReference, @ref Magnum::Vk::SubpassDescription, @ref Magnum::Vk::SubpassDependency, @ref Magnum::Vk::RenderPassCreateInfo, enum @ref Magnum::Vk::AttachmentLoadOperation, @ref Magnum::Vk::AttachmentStoreOperation
* @m_since_latest
*/
#include <utility>

Loading…
Cancel
Save