From c913db810b7ea85da9acb4805068c2a6cacf3522 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= <mosra@centrum.cz>
Date: Thu, 21 Jan 2021 17:34:49 +0100
Subject: [PATCH] Vk: document required ImageUsage in all APIs taking images.

---
 src/Magnum/Vk/FramebufferCreateInfo.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/Magnum/Vk/FramebufferCreateInfo.h b/src/Magnum/Vk/FramebufferCreateInfo.h
index 5b96e872a..d5dcab5be 100644
--- a/src/Magnum/Vk/FramebufferCreateInfo.h
+++ b/src/Magnum/Vk/FramebufferCreateInfo.h
@@ -75,7 +75,12 @@ class MAGNUM_VK_EXPORT FramebufferCreateInfo {
          * @param renderPass    A @ref RenderPass or a raw Vulkan render pass
          *      handle the framebuffer is compatible with
          * @param attachments   Image views corresponding to all attachments
-         *      listed in @ref RenderPassCreateInfo::setAttachments()
+         *      listed in @ref RenderPassCreateInfo::setAttachments(). All
+         *      images the views are created from are expected to have been
+         *      created with @ref ImageUsage::ColorAttachment /
+         *      @ref ImageUsage::DepthStencilAttachment /
+         *      @ref ImageUsage::InputAttachment based on what they are
+         *      attached to.
          * @param size          Width, height and layer count of the
          *      framebuffer. Available through @ref Framebuffer::size()
          *      afterwards.