]> O.S.I.I.S - jp/vke.net.git/commitdiff
update docs
authorShawdooow <banhammer1915@gmail.com>
Sat, 20 Nov 2021 23:44:13 +0000 (18:44 -0500)
committerJean-Philippe Bruyère <jp_bruyere@hotmail.com>
Sun, 21 Nov 2021 11:59:27 +0000 (12:59 +0100)
vke/src/ShaderInfo.cs
vke/src/Utils.cs

index 57f39742d4722aaf07850a7a1940d771a0debc50..7cc498b61e833b33e41abc9f705eb618f571b686 100644 (file)
@@ -43,7 +43,7 @@ namespace vke {
                /// </summary>
                /// <param name="dev">vke Device</param>
                /// <param name="_stageFlags">Stage flags.</param>
-               /// <param name="_spirvPath">path to a compiled SpirV Shader on disk or as embedded ressource if path starts with '#'</param>
+               /// <param name="_spirvPath">path to a compiled SpirV Shader on disk or as embedded ressource if path contains ':' (ex; Assembly:shader.vert.spv)</param>
                /// <param name="specializationInfo">Specialization info</param>
                /// <param name="entryPoint">shader entry point, 'main' by default.</param>
                public ShaderInfo (Device dev, VkShaderStageFlags _stageFlags, string _spirvPath, SpecializationInfo specializationInfo = null, string entryPoint = "main"):
index e82fc39ce179af83764188cc20d2f58dfc16968a..0a1ef6c14a5a0e860f8035af048970ff3877d4d2 100644 (file)
@@ -37,10 +37,10 @@ namespace Vulkan {
                }
                /// <summary>
                /// Return a file or embedded resource stream.
-               /// Use : to split assembly and resource (ex; Assembly:shader.vert.spv)
+               /// Use ':' to split assembly and resource (ex; "Assembly:shader.vert.spv")
                /// </summary>
                /// <returns>The stream from path.</returns>
-               /// <param name="path">The file or stream path. Embedded resource path starts with '#'.</param>
+               /// <param name="path">The file or stream path. Embedded resource path contains ':'.</param>
                public static Stream GetStreamFromPath (string path) {
                        if (path.Contains(":", StringComparison.Ordinal)) {
                                Stream stream = null;