Skip to content

Conversation

@gpx1000
Copy link
Collaborator

@gpx1000 gpx1000 commented Dec 15, 2025

Description

This might be considered a WIP until we have figured out how to get the CI and other tooling to work with Complex samples.
This is the simple game engine from the Vulkan Tutorial. It has been updated for several new features to demonstrate more complicated sample of how to work with the game engine.

Fixes #

General Checklist:

Please ensure the following points are checked:

  • My code follows the coding style
  • I have reviewed file licenses
  • I have commented any added functions (in line with Doxygen)
  • I have commented any code that could be hard to understand
  • My changes do not add any new compiler warnings
  • My changes do not add any new validation layer errors or warnings
  • I have used existing framework/helper functions where possible
  • My changes do not add any regressions
  • I have tested every sample to ensure everything runs correctly
  • This PR describes the scope and expected impact of the changes I am making

Note: The Samples CI runs a number of checks including:

  • I have updated the header Copyright to reflect the current year (CI build will fail if Copyright is out of date)
  • My changes build on Windows, Linux, macOS and Android. Otherwise I have documented any exceptions

If this PR contains framework changes:

  • I did a full batch run using the batch command line argument to make sure all samples still work properly

Sample Checklist

If your PR contains a new or modified sample, these further checks must be carried out in addition to the General Checklist:

  • I have tested the sample on at least one compliant Vulkan implementation
  • If the sample is vendor-specific, I have tagged it appropriately
  • I have stated on what implementation the sample has been tested so that others can test on different implementations and platforms
  • Any dependent assets have been merged and published in downstream modules
  • For new samples, I have added a paragraph with a summary to the appropriate chapter in the readme of the folder that the sample belongs to e.g. api samples readme
  • For new samples, I have added a tutorial README.md file to guide users through what they need to know to implement code using this feature. For example, see conditional_rendering
  • For new samples, I have added a link to the Antora navigation so that the sample will be listed at the Vulkan documentation site

This pulls in the Vulkan Tutorial's Simple Game Engine and uses it to demonstrate new features.
New features (not an exhaustive list):
ray query pipeline
forward+ pipeline
reflections
culling
synch 2
streaming and threaded loading
LOD and mipmaps
@gary-sweet
Copy link
Contributor

This will need direct-to-display support. It won't build for me currently:

CMake Error at samples/Complex/simple_game_engine/CMakeLists.txt:17 (find_package):
  By not providing "Findglfw3.cmake" in CMAKE_MODULE_PATH this project has
  asked CMake to find a package configuration file provided by "glfw3", but
  CMake did not find one.

  Could not find a package configuration file provided by "glfw3" with any of
  the following names:

    glfw3Config.cmake
    glfw3-config.cmake

  Add the installation prefix of "glfw3" to CMAKE_PREFIX_PATH or set
  "glfw3_DIR" to a directory containing one of the above files.  If "glfw3"
  provides a separate development package or SDK, be sure it has been
  installed.

@SaschaWillems
Copy link
Collaborator

SaschaWillems commented Dec 15, 2025

I'm on Windows, but I'm getting the same error as Gary.

Does this actually use the build system of the samples, or does it use it's own build system? If the latter, does it require vcpkg?

@gpx1000
Copy link
Collaborator Author

gpx1000 commented Dec 16, 2025

It requires vcpkg. I'm going to go ahead and close this PR as per discussion in the Samples call, this is being moved to the Tutorial. I'll add direct-to-display support there. Making an issue for it now.

@gpx1000 gpx1000 closed this Dec 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants