🎲 Modern 3D graphics made simple with C++17 cross-platform framework and rendering abstraction API on top of DirectX 12, Metal & Vulkan
Alternatives To Methanekit
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
2 days ago6April 13, 2023283bsd-2-clauseC++
Cross-platform, graphics API agnostic, "Bring Your Own Engine/Framework" style rendering library.
21 hours ago52mitC++
RenderDoc is a stand-alone graphics debugging tool.
a day ago45mitC++
3D engine with modern graphics
The Forge3,775
a month ago21apache-2.0C++
The Forge Cross-Platform Rendering Framework PC Windows, Linux, Ray Tracing, macOS / iOS, Android, XBOX, PS4, PS5, Switch, Quest 2
17 hours ago17apache-2.0Batchfile
A modern cross-platform low-level graphics library and rendering framework
a day ago9bsd-3-clauseC++
Low Level Graphics Library (LLGL) is a thin abstraction layer for the modern graphics APIs OpenGL, Direct3D, Vulkan, and Metal
4 years ago106mitC++
Modern C++14 library for the development of real-time graphical applications
4 days ago76mitC++
4 years ago39zlibC++
A Direct3D9 to Vulkan layer using the DXVK backend. [Upstreamed to DXVK]
12 days ago18mitC++
A simple framework for rapid prototyping on Vulkan or Direct3D 12
Alternatives To Methanekit
Select To Compare

Alternative Project Comparisons

Methane Kit

CI Build CI CodeQL Scan CI Sonar Scan Quality Gate Status CodeCov Test Space Metric Gitpod Ready-to-Code

Easy to use modern 3D graphics rendering abstraction API and cross-platform application framework:

  • Builds on top of modern native 3D graphics APIs: DirectX 12 on Windows, Vulkan on Linux, Metal on MacOS, iOS & tvOS.
  • Simplifies modern graphics programming with object-oriented medium-level graphics API inspired by simplicity of Apple Metal. Common shaders code in HLSL 6 is used on all platforms.
  • Provides cross-platform application framework with CMake build toolchain, platform-independent application foundation classes and native-GUI layer for Windows, Linux and MacOS.

Download release builds with pre-built samples, tutorials and tests to try them out. Check latest build status, tests, code coverage and analysis results or get build artifacts from GitHub Actions CI and Sonar Cloud. See Build Instructions topic for manual build instructions and start learning Methane Graphics RHI API with Hello Triangle and other tutorials' documentation.

Open in Gitpod

Platform Graphics API Master Build Develop Build
Windows x64 DirectX 12 Windows x64 Master Build Windows x64 Develop Build
Windows x86 DirectX 12 Windows x86 Master Build Windows x86 Develop Build
Windows x64 Vulkan Windows x64 Master Build Windows x64 Develop Build
Windows x86 Vulkan Windows x86 Master Build Windows x86 Develop Build
Linux Vulkan Ubuntu Master Build Ubuntu Develop Build
MacOS Vulkan MacOS Master Build MacOS Develop Build
MacOS Metal MacOS Master Build MacOS Develop Build
iOS (Sim) Metal iOS Master Build iOS Develop Build
tvOS (Sim) Metal tvOS Master Build tvOS Develop Build

Static code analysis scans are performed as a part of automated CI build process on master and develop branches with up-to-date results published on Sonar Cloud.

Platform Sonar Quality Gate Master Scan Status Develop Scan Status
Windows DirectX Windows Quality Gate Status Windows Master Scan Status Windows Develop Scan Status
Linux Vulkan Linux Quality Gate Status Linux Master Scan Status Linux Develop Scan Status
MacOS Metal MacOS Quality Gate Status MacOS Master Scan Status MacOS Develop Scan Status

Windows Maintainability Rating Windows Reliability Rating Windows Security Rating Windows Code Smells Windows Duplicated Lines (%) Windows Coverage Windows Lines of Code

Asteroids Sample on Windows

Asteroids sample demonstrating multi-threaded rendering with Methane Kit

Build Instructions

Getting Started

High-Level Architecture

Methane Kit architecture is clearly distributing library modules between 5 layers from low to high level of abstraction. High Level Architecture

Rendering Hardware Interface (RHI)

Methane Graphics RHI module implements a set of public object-oriented interfaces, which make modern graphics programming easy and convenient in a platform and API independent way. Graphics RHI


Start learning Methane Graphics API with Hello Triangle tutorial documentation and continue with others.

Name / Link
1. Hello Triangle Hello Triangle on Windows Colored triangle rendering in 100 lines of code.
2. Hello Cube Hello Cube on Windows Colored cube rendering in 200 lines of code with vertex and index buffers.
3. Textured Cube Textured Cube on Windows Textured cube introduces buffers, textures and samplers usage with Phong shading.
4. Shadow Cube Shadow Cube on Windows Shadow cube introduces multi-pass rendering with render passes.
5. Typography Typography on Windows Typography demonstrates animated text rendering with dynamic font atlas updates using Methane UI.
6. Cube-Map Array Cube-Map Array on Windows Cube-map array texturing along with sky-box rendering.
7. Parallel Rendering Parallel Rendering on Windows Parallel rendering of the textured cube instances to the single render pass.
8. Console Compute Console Compute on Windows Conway's Game of Life implemented in Compute Shader and running in pure console application.


Methane samples demonstrate advanced techniques and usage scenarios with more complex implementation than tutorials above. Samples are distributes in form of separate repositories.

Name / Link
Asteroids Asteroids on Windows Benchmark demonstrating parallel render commands encoding in a single render pass for the large number of heterogeneous asteroid objects processed in multiple threads.


  • Cross-platform application & input classes: Windows, MacOS and Linux are supported
    • CMake modules for convenient application build configuration, adding shaders and embedded resources
    • HLSL-6 Shaders serving all graphics APIs converted to native shader language and compiled in build time with SPIRV-Cross & DirectXCompiler
    • HLSL++ Math library with HLSL-like syntax in C++ and vector-instruction optimizations for different platforms
  • Modern Graphics API abstractions: based on DirectX 12, Vulkan and Metal APIs
    • Render state and program configuration with compact initialization syntax
    • Program binding objects implement efficient binding of shader arguments to resources
    • Automatic resource state tracking used for automatic resource transition barriers setup
    • Resources are automatically retained from destroying while in use on GPU with shared pointers in command list state
    • Command list execution state tracking with optional GPU timestamps query on completion
    • Parallel render command list for multi-threaded render commands encoding in single render pass
    • Multiple command queues execution on GPU with synchronization using fences
    • Private GPU resources asynchronously updated through the upload command list and shared resource
    • Registry of named graphics objects enabling reuse of render states and graphics resources between renderer objects
  • Graphics primitives and extensions:
    • Graphics application base class with per-frame resource management and frame buffers resizing enable effective triple buffering
    • Camera primitive and interactive arc-ball camera
    • Procedural mesh generation for quad, box, sphere, icosahedron and uber-mesh
    • Screen-quad and sky-box rendering extension classes
    • Texture loader (currently implemented with STB, planned for replacement with OpenImageIO)
  • User Interface:
    • UI application base class with integrated HUD, logo badge and help/parameters text panels
    • Typography library for fonts loading, dynamic atlas updating, text rendering & layout
    • Widgets library (under development)
  • Platform Infrastructure:
    • Base application with window management and input handling for Windows, MacOS and Linux
    • Events mechanism connecting emitters and receivers via callback interfaces
    • Animations subsystem
    • Embedded resource providers
  • Integrated debugging and profiling capabilities:
  • Continuous integration with automated multi-platform builds, unit-tests and Sonar Cloud static code analysis in GitHub Actions

For detailed features description and development plans please refer to Modules documentation.

Supported Development Tools

Development Environments

Methane Kit is being developed with support of Jet Brains development tools. Open source project development license is provided free of charge to all key contributors of Methane Kit project.

Static Code Analysis

Methane Kit comes with continuous C++ static code and code coverage analysis performed as a part of automated CI "Scan" builds with up-to-date results published on Sonar Cloud separately for all supported platforms.

Master Scan Results Windows MacOS Linux
Scan Build Status Windows Master Scan Status MacOS Master Scan Status Linux Master Scan Status
Quality Gate Windows Quality Gate Status MacOS Quality Gate Status Linux Quality Gate Status
Maintainability Windows Maintainability Rating MacOS Maintainability Rating Linux Maintainability Rating
Reliability Windows Reliability Rating MacOS Reliability Rating Linux Reliability Rating
Security Windows Security Rating MacOS Security Rating Linux Security Rating
Technical Debt Windows Technical Debt MacOS Technical Debt Linux Technical Debt
Bugs Windows Bugs MacOS Bugs Linux Bugs
Vulnerabilities Windows Vulnerabilities MacOS Vulnerabilities Linux Vulnerabilities
Code Smells Windows Code Smells MacOS Code Smells Linux Code Smells
Duplicated Lines Windows Duplicated Lines (%) MacOS Duplicated Lines (%) Linux Duplicated Lines (%)
Tests Coverage Windows Coverage MacOS Coverage Linux Coverage
Lines of Code Windows Lines of Code MacOS Lines of Code Linux Lines of Code

Trace Profiling Tools

Methane Kit contains integrated instrumentation of all libraries for performance analysis with trace collection using following tools. Please refer to Methane Instrumentation document for more details on trace collection instructions and related build options.

Tracy Frame Profiler Intel Graphics Trace Analyzer
Asteroids Trace in Tracy Asteroids Trace in GPA Trace Analyzer

Frame Profiling and Debugging Tools

External Dependencies


Methane Kit is distributed under Apache 2.0 License: it is free to use and open for contributions!

Copyright 2019-2022 © Evgeny Gorodetskiy Follow

Popular Vulkan Projects
Popular Directx Projects
Popular Graphics Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
C Plus Plus
3d Graphics
Game Development
Graphics Programming
Graphics Engine
3d Engine
Graphics Library
Vulkan Api