From: Jacob Lifshay <programmerjake@gmail.com>
Date: Mon, 28 Aug 2017 06:00:19 +0000 (-0700)
Subject: add image.md
X-Git-Tag: gsoc-2017~18
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=294c4b501d210c07c6a0868e0f6712e0ba90b9fb;p=kazan.git

add image.md
---

diff --git a/docs/image.md b/docs/image.md
new file mode 100644
index 0000000..04d7c31
--- /dev/null
+++ b/docs/image.md
@@ -0,0 +1,27 @@
+# image library
+
+## `image/image.h`
+
+### `image::Image_descriptor`
+`struct` holding all an Image's state, except for the actual memory block.  
+Members:
+- `supported_flags`: the `VkImageCreateFlags` that are supported by this implementation.
+- `flags`
+- `type`
+- `format`
+- `extent`
+- `mip_levels`
+- `array_layers`
+- `supported_samples`: the samples-per-pixel values that are supported by this implementation.
+- `samples`
+- `tiling`
+- `get_memory_size`: returns the size of the memory block for this image.
+- `get_memory_stride`: for linear tiling, returns the size of a row of pixels.
+- `get_memory_pixel_size`: for linear tiling, returns the size of a pixel.
+
+### `image::Image`
+A Vulkan image.  
+Members:
+- `descriptor`: the `Image_descriptor` for this image.
+- `memory`: the memory block for this image.
+- `clear`: clear the image to the specified color. Slow implementation of `vkCmdClearColorImage`.