<br>adaptation of the gltf PBR sample from Sacha Willems</br>
</p>
-**vke.net** (_vulkan engine for .net_) is composed of high level classes encapsulating [vulkan]() objects and commands with `IDispose` model and **reference counting**. [GLFW](https://www.glfw.org/) handles the windowing system.
+### Presentattion
+**vke.net** (_vulkan engine for .net_) a vulkan abstraction layer writen in c# composed of high level classes encapsulating [vulkan](https://www.khronos.org/vulkan/) objects and commands with `IDispose` model and **reference counting**. [GLFW](https://www.glfw.org/) handles the windowing system.
Vke use autogenerated [vk.net](https://github.com/jpbruyere/vk.net) library for low level binding to vulkan.
Use the 'download_datas.sh' script for downloading sample's datas.
+vke is in early development stage.
+
### Requirements
- [GLFW](https://www.glfw.org/) if you use the `VkWindow` class.
- If you want to use `jpg`, `jpeg`, `png` image [libstb](https://github.com/nothings/stb) (on debian install **libstb-dev**). Note that `ktx` image loading has no dependencies.
### Quick Start
-Create a new dotnet console project, and add the [vje nuget package](https://www.nuget.org/packages/vke) to it.
+Create a new dotnet console project, and add the [vke nuget package](https://www.nuget.org/packages/vke) to it.
```xml
<Project Sdk="Microsoft.NET.Sdk">
- <TargetFrameworks>net472</TargetFrameworks>
- <OutputType>Exe</OutputType>
-
- <ItemGroup>
- <PackageReference Include="vke" />
- </ItemGroup>
+ <TargetFrameworks>net472</TargetFrameworks>
+ <OutputType>Exe</OutputType>
+
+ <ItemGroup>
+ <PackageReference Include="vke" />
+ </ItemGroup>
</Project>
```
-For automatic shader compilation to SpirV, add also the [SpirVTasks nuget package](https://www.nuget.org/packages/SpirVTasks/0.1.41-beta). For documentation about this module, follow [this link](SpirVTasks/README.md).
+For automatic shader compilation to SpirV, add also the [SpirVTasks](SpirVTasks/README.md) nuget package.
```xml
- <ItemGroup>
- <PackageReference Include="SpirVTasks" />
- <GLSLShader Include="shaders\*.*" />
- </ItemGroup>
-
+ <ItemGroup>
+ <PackageReference Include="SpirVTasks" />
+ <GLSLShader Include="shaders\*.*" />
+ </ItemGroup>
```
### Samples
-| Title | Screen shots |
-| :----------------------------------: | :------------------------------------------------: |
-| [ClearScreen](ClearScreen/README.md) |  |
-| [Triangle](Triangle/README.md) |  |
-| [Textured](Textured/README.md) |  |
+| Title | Screen shots |
+| :------------------------------------------: | :------------------------------------------------: |
+| [ClearScreen](samples/ClearScreen/README.md) |  |
+| [Triangle](samples/Triangle/README.md) |  |
+| [Textured](samples/Textured/README.md) |  |