Ryujinx/moltenvk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
moltenvk/Demos/README.md

52 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
<a class="site-logo" href="https://github.com/KhronosGroup/MoltenVK" title="MoltenVK">
<img src="../Docs/images/MoltenVK-Logo-Banner.png" alt="MoltenVK" style="width:256px;height:auto">
</a>
#MoltenVK Demo Projects
Update copyright notices to year 2024.
2024-01-04 14:51:53 -05:00
Copyright (c) 2015-2024 [The Brenwill Workshop Ltd.](http://www.brenwill.com)
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Documentation updates. Add link to Vulkan SDK Getting Started doc to README.md and MoltenVK_Runtime_UserGuide.md documents. Add Github CI badge to README.md, and remove Travis CI badge. Make document notices of use of Markdown into comments so they are invisible when using a Markdown reader.
2021-01-21 14:49:24 -05:00
[comment]: # "This document is written in Markdown (http://en.wikipedia.org/wiki/Markdown) format."
[comment]: # "For best results, use a Markdown reader."
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Table of Contents
-----------------
Remove LunarG/VulkanSamples as a dependency library. LunarG is planning to retire the LunarG/VulkanSamples repository. Remove dependency to it, and remove the affected Hologram and API-Samples demo apps. Update documents, including directing developers to the KhronosGroup/Vulkan-Samples repository for official demo apps.
2021-03-03 16:43:11 -05:00
- [*Cube*](#vulkan-tools-cube)
- [Khronos Vulkan-Samples](#khronos-vulkan-samples)
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Remove LunarG/VulkanSamples as a dependency library. LunarG is planning to retire the LunarG/VulkanSamples repository. Remove dependency to it, and remove the affected Hologram and API-Samples demo apps. Update documents, including directing developers to the KhronosGroup/Vulkan-Samples repository for official demo apps.
2021-03-03 16:43:11 -05:00
<a name="vulkan-tools-cube"></a>
*Cube*
------
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Fixes from dev review feedback for adding VK_EXT_layer_settings extension. - Document the name of the MoltenVK driver layer. - Support future multiple string members in MVKConfiguration. - Add static assert on number of string members in MVKConfigruation. - Rename global mvkConfig() to getGlobalMVKConfig(). - Rename global mvkSetConfig() to mvkSetGlobalConfig(). - Remove unused mvkPrintSizeOf() macro. (unrelated). - Trim trailing spaces from Markdown documents because it causes double-spaces in some Markdown readers (unrelated).
2023-12-18 11:00:35 -05:00
The basic canonical *Cube* sample app from the
[*Vulkan-Tools* repository](https://github.com/KhronosGroup/Vulkan-Tools)
Remove LunarG/VulkanSamples as a dependency library. LunarG is planning to retire the LunarG/VulkanSamples repository. Remove dependency to it, and remove the affected Hologram and API-Samples demo apps. Update documents, including directing developers to the KhronosGroup/Vulkan-Samples repository for official demo apps.
2021-03-03 16:43:11 -05:00
is included in this **MoltenVK** package.
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Remove LunarG/VulkanSamples as a dependency library. LunarG is planning to retire the LunarG/VulkanSamples repository. Remove dependency to it, and remove the affected Hologram and API-Samples demo apps. Update documents, including directing developers to the KhronosGroup/Vulkan-Samples repository for official demo apps.
2021-03-03 16:43:11 -05:00
This demo renders a basic textured cube that spins in place.
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Fixes from dev review feedback for adding VK_EXT_layer_settings extension. - Document the name of the MoltenVK driver layer. - Support future multiple string members in MVKConfiguration. - Add static assert on number of string members in MVKConfigruation. - Rename global mvkConfig() to getGlobalMVKConfig(). - Rename global mvkSetConfig() to mvkSetGlobalConfig(). - Remove unused mvkPrintSizeOf() macro. (unrelated). - Trim trailing spaces from Markdown documents because it causes double-spaces in some Markdown readers (unrelated).
2023-12-18 11:00:35 -05:00
The demo can be found in the `Cube` folder, and in the `Cube` group in the
Remove LunarG/VulkanSamples as a dependency library. LunarG is planning to retire the LunarG/VulkanSamples repository. Remove dependency to it, and remove the affected Hologram and API-Samples demo apps. Update documents, including directing developers to the KhronosGroup/Vulkan-Samples repository for official demo apps.
2021-03-03 16:43:11 -05:00
*Xcode Project Navigator* in the `Demos.xcworkspace` *Xcode* workspace.
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Update dependency libraries to match Vulkan SDK 1.3.275. - Hide static Vulkan API symbols by default (build setting MVK_HIDE_VULKAN_SYMBOLS=1 by default). - Update documentation.
2024-01-08 21:35:21 -05:00
To run this demo, run the `Cube-macOS`, `Cube-iOS`, or `Cube-tvOS` *Scheme* from within *Xcode*.
Support libMoltenVK.dylib for iOS Simulator architecture. - Xcode now supports building dylib for iOS Simulator (but unfortunately not yet tvOS Simulator). - Restore support for iOS Simulator destination in recent update to Cube demo that uses dynamic-linking, by using script build phase to overwrite the iOS build of MoltenVK with the iOS Simulator build.
2024-01-23 12:24:36 -05:00
In addition to devices, this demo will also run on an `iOS Simulator` destination.
This demo is not supported on a `tvOS Simulator` destination.
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Revert to disabling MVK_HIDE_VULKAN_SYMBOLS by default. - Statically expose vkGetInstanceProcAddr(), even when MVK_HIDE_VULKAN_SYMBOLS is enabled. - To support Volk, link Cube demo dynamically to libMoltenVK.dylib instead of statically to MoltenVK.xcframework.
2024-01-10 17:16:33 -05:00
The `Cube` demo is a simple example of installing **MoltenVK** as a `libMoltenVK.dylib` library that
is dynamically linked to the application, and the _Vulkan_ calls all use _Volk_ to dynamically access
function pointers, retrieved from **MoltenVK** using `vkGetInstanceProcAddr()` and `vkGetDeviceProcAddr()`.
It supports all platforms, including _Mac Catalyst_, _iOSSimulator_ and _tvOS Simulator_.
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Remove LunarG/VulkanSamples as a dependency library. LunarG is planning to retire the LunarG/VulkanSamples repository. Remove dependency to it, and remove the affected Hologram and API-Samples demo apps. Update documents, including directing developers to the KhronosGroup/Vulkan-Samples repository for official demo apps.
2021-03-03 16:43:11 -05:00
<a name="khronos-vulkan-samples"></a>
*Khronos Vulkan Samples*
----------------------
Automatically install demo apps. Add LunarG demo app repository as a submodule. Add LunarG demo config to makeAll script. Rename Demos/README_MoltenVK_Demos.md to Demos/README.md. Do not copy Demos folder to MoltenVK runtime distribution. Do not copy ThirdPartyConfig.md to MoltenVK runtime distribution. Add cmake as a dependency in README.md.
2018-03-06 14:07:06 -05:00
Fixes from dev review feedback for adding VK_EXT_layer_settings extension. - Document the name of the MoltenVK driver layer. - Support future multiple string members in MVKConfiguration. - Add static assert on number of string members in MVKConfigruation. - Rename global mvkConfig() to getGlobalMVKConfig(). - Rename global mvkSetConfig() to mvkSetGlobalConfig(). - Remove unused mvkPrintSizeOf() macro. (unrelated). - Trim trailing spaces from Markdown documents because it causes double-spaces in some Markdown readers (unrelated).
2023-12-18 11:00:35 -05:00
*Khronos Group* provides a [repository](https://github.com/KhronosGroup/Vulkan-Samples)
Remove LunarG/VulkanSamples as a dependency library. LunarG is planning to retire the LunarG/VulkanSamples repository. Remove dependency to it, and remove the affected Hologram and API-Samples demo apps. Update documents, including directing developers to the KhronosGroup/Vulkan-Samples repository for official demo apps.
2021-03-03 16:43:11 -05:00
containing a full suite of standard *Vulkan* samples that run on **MoltenVK** on *macOS*.
Reference in New Issue Copy Permalink