Getting Started with Helix Toolkit NEX
This guide will help you get started with Helix Toolkit NEX.
Prerequisites
- .NET 8.0 SDK or later
- Vulkan 1.2 compatible GPU and drivers
- Visual Studio 2022 or JetBrains Rider (recommended)
Installation
NuGet Packages (When Available)
dotnet add package HelixToolkit.Nex.Graphics
dotnet add package HelixToolkit.Nex.Graphics.Vulkan
dotnet add package HelixToolkit.Nex.Maths
Building from Source
- Clone the repository:
git clone https://github.com/helix-toolkit/helix-toolkit-nex.git
cd helix-toolkit-nex
- Build the solution:
dotnet build Source/HelixToolkit-Nex/HelixToolkit-Nex.sln
Basic Usage
Creating a Graphics Context
using HelixToolkit.Nex.Graphics;
using HelixToolkit.Nex.Graphics.Vulkan;
// Create Vulkan context
var builder = new VulkanBuilder();
var context = builder
.WithDebug(true)
.WithValidation(true)
.Build();
// Initialize the context
context.Initialize();
Creating a Simple Triangle
See the HelloTriangle sample for a complete example of rendering a triangle.
Next Steps
- Explore the API Reference
- Check out the Samples directory for complete examples
- Read about Core Concepts