Welcome to Helix Toolkit Documentation
Helix Toolkit is a collection of 3D components for .NET Framework.
This documentation provides comprehensive API reference and guides for using Helix Toolkit in your .NET applications.
What is Helix Toolkit?
Helix Toolkit is a powerful 3D graphics library that provides a rich set of components for creating 3D visualizations in .NET applications. It supports multiple platforms and rendering engines:
- WPF Applications: Traditional Windows Presentation Foundation
- WinUI Applications: Modern Windows app development
- Avalonia Applications: Cross-platform UI framework
- DirectX 11: High-performance rendering via SharpDX
Documentation Sections
API Documentation
Complete API reference automatically generated from source code, including:
- Namespace documentation
- Class and interface definitions
- Method signatures and descriptions
- Property details
- Usage examples (where available)
Articles
Conceptual documentation and guides:
- Getting started tutorials
- Best practices
- Common scenarios
- Performance optimization tips
Key Features
- Scene Graphs: XAML/MVVM compatible scene graphs for WPF, WinUI, and Avalonia
- 3D Models: Built-in support for common 3D shapes and model loading
- Materials & Lighting: Comprehensive material and lighting systems
- Camera Control: Flexible camera manipulation and control
- Performance: Optimized for real-time 3D rendering
- Extensibility: Easy to extend with custom components
Getting Started
- Install via NuGet: Add the appropriate Helix Toolkit package to your project
- Explore the API: Browse the API Documentation
- Read Guides: Check out the Articles section
- Try Examples: Download the source code to run example applications
Package Overview
| Package | Description |
|---|---|
| HelixToolkit | Core components shared across projects |
| HelixToolkit.Maths | Math library supporting System.Numerics |
| HelixToolkit.Geometry | Geometry builder library for common shapes |
| HelixToolkit.SharpDX | Custom 3D engine based on DirectX 11 |
| HelixToolkit.Wpf.SharpDX | WPF bindings for SharpDX engine |
| HelixToolkit.WinUI.SharpDX | WinUI bindings for SharpDX engine |
| HelixToolkit.Avalonia.SharpDX | Avalonia bindings for SharpDX engine |
| HelixToolkit.Wpf | Components for WPF's built-in 3D (Media3D) |
Community & Support
- GitHub: https://github.com/helix-toolkit/helix-toolkit
- Issues: Report bugs or request features
- Wiki: Community wiki with additional resources
- Chat: Join our Gitter channel
License
Helix Toolkit is licensed under the MIT License. See the LICENSE file for details.
This documentation is automatically generated and deployed using DocFX.