Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up

Desktop/Android Python game development framework on top of Vulkan API

License

NotificationsYou must be signed in to change notification settings

realitix/vulk

Repository files navigation

Project status

Build StatusCoverage Status

Documentation |API reference |Example of use

What is it ?

Vulk is a 3D engine aimed to provide the best graphical experience with Vulkan API.It is written fully in Python. It depends on C modules for the communication withVulkan.

What is the project goal ?

  • Easy to use: you don't need to understand Vulkan to use VULK.
  • Modular: every single part of the api must be modular.
  • Full: you shouldn't need to customize core code, it should suits everyone needs.

Documentation

Documentation is builded withmkdocs and thematerial theme.After each commit, Travis CI builds the documentation and pushes it in thevulk-doc repository. All the documentation is inside thedocs/ folder.You can easily contribute to it, it's markdown syntax. Check out themkdocs documentation.

To build the html documentation (in vulk-doc folder), execute the following commands:

pip install -r requirements.txtpython setup.py doc

API reference

The API documentation is generated after each commit by Travis CI serversinto the dedicated repo vulk-api. You can check it here:API reference

API convention

To make a beautiful API documentation, we must respect conventions.Instead of reinventing the wheel with syntax format, we use theGoogle Style Python Docstrings. Here a complete example:example.

Unit tests

To run the unit tests, execute the following command:

python setup.pytest

Dependancies

  • vulkan: Module to communicate with Vulkan SDK
  • pyshaderc: Module to compile GLSL to Spir-V
  • VulkBare: Module which provides helper functions

Stay in touch

You can contact me by opening issue (bug or interesting discussion aboutthe project). If you want a fast and pleasant talk, join the irc channel:#vulk. I'm connected from 9AM to 6PM (France).

About

Desktop/Android Python game development framework on top of Vulkan API

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

[8]ページ先頭

©2009-2025 Movatter.jp