diff options
| author | Jean-Philippe Bruyère <jp_bruyere@hotmail.com> | 2019-05-23 23:35:51 +0200 |
|---|---|---|
| committer | Jean-Philippe Bruyère <jp_bruyere@hotmail.com> | 2019-05-23 23:35:51 +0200 |
| commit | 8cb89e9ad7babc587f57445f29b61d06aeb60513 (patch) | |
| tree | 0b32418b3c19985c225e05027329f3053b56ce6a | |
| parent | 6ce348fea509d688250d902f8068c7b5067ebdef (diff) | |
update readme
| -rw-r--r-- | README.md | 17 | ||||
| -rw-r--r-- | vke/src/Instance.cs | 2 | ||||
| -rw-r--r-- | vke/src/ktx.cs | 2 |
3 files changed, 17 insertions, 4 deletions
@@ -24,7 +24,20 @@ The nuget package is available under the name **Vulkan**. <a href="https://www.nuget.org/packages/CVKL"><img src="https://buildstats.info/nuget/CVKL"></a> The second project included in this repository is a set of classes encapsulating vulkan objects with `IDispose` model and **reference counting**. [GLFW](https://www.glfw.org/) handles the windowing system. -Developping exclusively on linux, I would be glad to have some feedback frow windows experiences. + +Developping exclusively on linux, I would be glad to have some feedback from window experiences. + +### Requirements +- [GLFW](https://www.glfw.org/) +- [libstb](https://github.com/nothings/stb), on debian install **libstb-dev**. +- [Vulkan Sdk](https://www.lunarg.com/vulkan-sdk/), **glslc** has to be in the path. +- optionaly for ui, you will need [vkvg](https://github.com/jpbruyere/vkvg). + +### Features + +- physicaly based rendering, direct and deferred +- glTF 2.0 +- ktx image loading. ### VkWindow class @@ -61,7 +74,7 @@ protected override void createQueues () { ``` ### Rendering -The constructor of the VkWIndow will finish the vulkan initialisation, so that you may create pipelines, buffers, and so on in your constructor. +The constructor of the `VkWIndow` will finish the vulkan initialisation, so that you may create pipelines, buffers, and so on in your constructor. VkWindow will provide the default swapchain, but it's up to you to create the frame buffers. For the triangle example, create them in the `OnResize` override. ```csharp diff --git a/vke/src/Instance.cs b/vke/src/Instance.cs index 0b53e68..b4bcca0 100644 --- a/vke/src/Instance.cs +++ b/vke/src/Instance.cs @@ -36,7 +36,7 @@ namespace CVKL { public class Instance : IDisposable { /// <summary>If true, the VK_LAYER_KHRONOS_validation layer is loaded at startup; </summary> public static bool VALIDATION; - /// <summary>If true, the VK_EXT_DEBUG_UTILS_EXTENSION_NAME and VK_EXT_DEBUG_REPORT_EXTENSION_NAME device extensions are enabled</summary> + /// <summary>If true, the VK_EXT_debug_utils and VK_EXT_debug_report device extensions are enabled</summary> public static bool DEBUG_UTILS; /// <summary>If true, the VK_LAYER_RENDERDOC_Capture layer is loaded at startup; </summary> public static bool RENDER_DOC_CAPTURE; diff --git a/vke/src/ktx.cs b/vke/src/ktx.cs index af4ab49..227328d 100644 --- a/vke/src/ktx.cs +++ b/vke/src/ktx.cs @@ -40,7 +40,7 @@ namespace KTX { public class KTX { static byte[] ktxSignature = { 0xAB, 0x4B, 0x54, 0x58, 0x20, 0x31, 0x31, 0xBB, 0x0D, 0x0A, 0x1A, 0x0A }; - public unsafe static Image Load (Queue staggingQ, CommandPool staggingCmdPool, string ktxPath, VkImageUsageFlags usage = VkImageUsageFlags.Sampled, + public static Image Load (Queue staggingQ, CommandPool staggingCmdPool, string ktxPath, VkImageUsageFlags usage = VkImageUsageFlags.Sampled, VkMemoryPropertyFlags memoryProperty = VkMemoryPropertyFlags.DeviceLocal, bool generateMipmaps = true, VkImageTiling tiling = VkImageTiling.Optimal) { Image img = null; |