added demo.md
authorJacob Lifshay <programmerjake@gmail.com>
Mon, 28 Aug 2017 12:22:05 +0000 (05:22 -0700)
committerJacob Lifshay <programmerjake@gmail.com>
Mon, 28 Aug 2017 12:22:05 +0000 (05:22 -0700)
docs/demo.md [new file with mode: 0644]

diff --git a/docs/demo.md b/docs/demo.md
new file mode 100644 (file)
index 0000000..f0c2719
--- /dev/null
@@ -0,0 +1,21 @@
+# demo executable
+
+## `demo/demo.cpp`
+
+### `test::load_file`
+loads a SPIR-V shader into memory, swapping the endian if needed.
+
+### `test::dump_words`
+dumps a SPIR-V shader's binary form to `stderr`. Displays the individual bytes in little-endian format to promote readability of SPIR-V strings.
+
+### `test::load_shader`
+loads a SPIR-V shader, creating a `pipeline::Shader_module`.
+
+### `test::make_pipeline_layout`
+creates the `pipeline::Pipeline_layout` object.
+
+### `test::parse_unsigned_integer`
+utility function to parse an unsigned integer.
+
+### `test::test_main`
+the main function. Builds a `pipeline::Graphics_pipeline`, draws to an image, then saves the image to `output.bmp`