From f06806147b5b9c06185cb2c52d250c14a339eaee Mon Sep 17 00:00:00 2001 From: saschawillems Date: Sun, 14 Feb 2016 17:04:13 +0100 Subject: [PATCH] Added android readme (stub) --- README.md | 9 +++++++++ android/README.md | 25 +++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 android/README.md diff --git a/README.md b/README.md index 779a8572..2ccc3d7c 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ Use it to generate a platform-specific build configuration for building all exam All required headers and libs are included in the repository, building the examples should work out of the box. +The repository also contains a few Android examples to get started, check the [Android readme](./android/README.md) for details. + ## Examples ### Triangle @@ -181,6 +183,13 @@ Renders the vertex normals of a complex mesh with the use of a geometry shader. More of a playground than an actual example. Renders multiple meshes with different shaders (and pipelines) including a background. +
+## Android + +This repository also contains a few Android examples that are (for now) separated from the rest of the examples. See the [Android readme](./android/README.md) for details on what is included and how to build the examples. + +The examples already share a few source files with existing examples and might be integrated into them at some point. + ## Additional documentation - [Vulkan example base class](./documentation/examplebaseclass.md) diff --git a/android/README.md b/android/README.md new file mode 100644 index 00000000..74e4fcae --- /dev/null +++ b/android/README.md @@ -0,0 +1,25 @@ +# Vulkan examples and demos - Android + +## Building + +The examples have been built using Visual Studio 2015 and require the Android NDK for building. + +## Vulkan on Android + +Since Vulkan is not yet part of the Android OS (like OpenGL ES) the library and function pointers need to be dynamically loaded before using any of the Vulkan functions. See the **vulkanandroid.h** and **vulkanandroid.cpp** files in the base folder of the repositoy root for how this is done. + +**To run these examples you need a device with an Android image that suports Vulkan and has the libvulkan.so preinstalled!** + +## Examples + +### Triangle +---- + +### Texture mapping +---- + +### Mesh loading and rendering +---- + +### Compute shader particle system +----