Merge pull request #167 from hanton/fix_document_typos
Fix several document typos.
This commit is contained in:
commit
585bfd7e02
@ -258,7 +258,7 @@ can be included in your application source code as follows:
|
|||||||
|
|
||||||
where `HEADER_FILE` is one of the following:
|
where `HEADER_FILE` is one of the following:
|
||||||
|
|
||||||
- `vk_mvk_moltenvk.h` - Contains declarations and documenation for the functions, structures,
|
- `vk_mvk_moltenvk.h` - Contains declarations and documentation for the functions, structures,
|
||||||
and enumerations that define the behaviour of the `VK_MVK_moltenvk` *Vulkan* extension.
|
and enumerations that define the behaviour of the `VK_MVK_moltenvk` *Vulkan* extension.
|
||||||
|
|
||||||
- `mvk_vulkan.h` - This is a convenience header file that loads the `vulkan.h` header file
|
- `mvk_vulkan.h` - This is a convenience header file that loads the `vulkan.h` header file
|
||||||
@ -305,7 +305,7 @@ sophistication and difficulty:
|
|||||||
function, you are indicating that the remainder of the *SPIR-V* stream contains either
|
function, you are indicating that the remainder of the *SPIR-V* stream contains either
|
||||||
*MSL* source code, or *MSL* compiled code, respectively.
|
*MSL* source code, or *MSL* compiled code, respectively.
|
||||||
|
|
||||||
You can use the `MoltenVKShaderConverter` command-line tool found in this **MoltenVK** distribution
|
- You can use the `MoltenVKShaderConverter` command-line tool found in this **MoltenVK** distribution
|
||||||
package to convert your *SPIR-V* shaders to *MSL* source code, offline at development time,
|
package to convert your *SPIR-V* shaders to *MSL* source code, offline at development time,
|
||||||
in order to create the appropriate *MSL* code to load at runtime. The [section below](#shaders)
|
in order to create the appropriate *MSL* code to load at runtime. The [section below](#shaders)
|
||||||
discusses how to use this tool in more detail.
|
discusses how to use this tool in more detail.
|
||||||
|
@ -83,7 +83,7 @@ library you have retrieved.
|
|||||||
Once you have made changes, you can retrieve the updated library versions by running
|
Once you have made changes, you can retrieve the updated library versions by running
|
||||||
the `fetchDependencies` script again.
|
the `fetchDependencies` script again.
|
||||||
|
|
||||||
>***Note:*** If, after updating to new verions of the external libraries, you encounter
|
>***Note:*** If, after updating to new versions of the external libraries, you encounter
|
||||||
>build errors when building **MoltenVK**, review the instructions in the sections below
|
>build errors when building **MoltenVK**, review the instructions in the sections below
|
||||||
>to ensure all necessary external library files are included in the **MoltenVK** builds.
|
>to ensure all necessary external library files are included in the **MoltenVK** builds.
|
||||||
|
|
||||||
|
@ -212,7 +212,7 @@ be implemented or worked around.
|
|||||||
**MoltenVK** is a key component of the [*Khronos Vulkan Portability Initiative*](https://www.khronos.org/vulkan/portability-initiative),
|
**MoltenVK** is a key component of the [*Khronos Vulkan Portability Initiative*](https://www.khronos.org/vulkan/portability-initiative),
|
||||||
whose intention is to provide specifications, resources, and tools to allow developers to understand and design
|
whose intention is to provide specifications, resources, and tools to allow developers to understand and design
|
||||||
their *Vulkan* apps for maximum cross-platform compatibility and portability, including on platforms, such as
|
their *Vulkan* apps for maximum cross-platform compatibility and portability, including on platforms, such as
|
||||||
*macOS* and *iOS*, where a native *Vulkan* driver is not avaialble.
|
*macOS* and *iOS*, where a native *Vulkan* driver is not available.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -242,5 +242,5 @@ Property claims.
|
|||||||
|
|
||||||
### Code Formatting
|
### Code Formatting
|
||||||
|
|
||||||
When contirbuting code, please honour the code formatting style found in existing **MoltenVK** source code.
|
When contributing code, please honour the code formatting style found in existing **MoltenVK** source code.
|
||||||
In future, this will formally be enforced using `clang-format`.
|
In future, this will formally be enforced using `clang-format`.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user