LVGL logo LVGLSharp Cross-platform UI docs
中文 EN

NuGet

Install help, package choices, and a minimal example

This page summarizes the current 12-package LVGLSharp line so you can decide which combination fits your scenario.

Open repository Read the docs map
  • LVGLSharp.Forms
  • Runtime.Windows
  • Runtime.Linux
  • Runtime.Headless
Current baseline 9.5.0.5
Total packages 12
Published on NuGet 12
Covered by pack flow 12
Version and downloads Live badges
Hosting org IoTSharp

12 packages

Together these packages make up the package line currently maintained in the repository.

LVGLSharp.Forms

The main WinForms-style compatibility layer and the normal entry point for application code.

LVGLSharp.Core

Shared runtime abstractions, fonts, diagnostics, and helper infrastructure.

LVGLSharp.Interop

Low-level LVGL P/Invoke bindings for advanced integrations.

LVGLSharp.Native

Platform-native LVGL assets and publish-time targets.

LVGLSharp.Runtime.Windows

Windows desktop runtime for validation and application hosting.

LVGLSharp.Runtime.Linux

Linux runtime covering WSLg, X11, Wayland, SDL, and FrameBuffer paths.

LVGLSharp.Runtime.Headless

Headless rendering support for snapshots, regression checks, and automation.

LVGLSharp.Runtime.MacOs

macOS runtime boundary package with diagnostics and early host scaffolding.

LVGLSharp.Runtime.Remote

Remote runtime abstractions for sessions, frames, input, and VNC/RDP-oriented work.

Additional packages

These 3 packages are part of the same package line and are published alongside the rest of the lineup.

LVGLSharp.Drawing

Cross-platform drawing primitives without a direct System.Drawing dependency.

LVGLSharp.WPF

Experimental WPF-like bootstrap and XAML runtime loader.

LVGLSharp.Analyzers

Roslyn analyzers that are normally brought in transitively by LVGLSharp.Forms.

Choose by scenario

If you do not want to learn the full package structure first, start from the scenario that matches your goal.

Windows-only validation

Start with LVGLSharp.Forms + LVGLSharp.Runtime.Windows.

 Cross-platform validation

Add both Windows and Linux runtimes if you plan to build or verify across multiple hosts.

 Snapshots and automation

Add LVGLSharp.Runtime.Headless when you need screenshots, headless rendering, or regression checks.

 Remote display work

Add LVGLSharp.Runtime.Remote only when you are intentionally building remote-session scenarios.

Recommended install path

If you are evaluating the project for the first time, this is the simplest order.

  1. Add `LVGLSharp.Forms` first
  2. Add `LVGLSharp.Runtime.Windows` or `LVGLSharp.Runtime.Linux` based on your target
  3. Add `LVGLSharp.Runtime.Headless` only when you need snapshots or automation
  4. Add `LVGLSharp.Runtime.Remote` or `LVGLSharp.Runtime.MacOs` only for deliberate advanced exploration
  5. Keep `ApplicationConfiguration.Initialize()` as the unified startup entry

12-Package Overview

The table below uses live NuGet badges for versions and download counts across the full package line.

Package Version Downloads Status Description
LVGLSharp.Forms LVGLSharp.Forms NuGet Published on NuGet Main application-facing package with WinForms-style APIs and runtime registration entry points.
LVGLSharp.Core LVGLSharp.Core NuGet Published on NuGet Shared runtime abstractions, fonts, diagnostics, and host helpers.
LVGLSharp.Drawing LVGLSharp.Drawing NuGet Published on NuGet Cross-platform drawing primitives shared by the runtime and UI layers.
LVGLSharp.Interop LVGLSharp.Interop NuGet Published on NuGet Auto-generated low-level LVGL P/Invoke bindings.
LVGLSharp.Native LVGLSharp.Native NuGet Published on NuGet RID-specific native LVGL assets and publish-time targets.
LVGLSharp.Runtime.Windows LVGLSharp.Runtime.Windows NuGet Published on NuGet Windows desktop runtime with Win32 hosting support.
LVGLSharp.Runtime.Linux LVGLSharp.Runtime.Linux NuGet Published on NuGet Linux runtime covering WSLg, X11, Wayland, SDL, and FrameBuffer paths.
LVGLSharp.Runtime.Headless LVGLSharp.Runtime.Headless NuGet Published on NuGet Headless runtime for offscreen rendering, snapshots, and automation.
LVGLSharp.Runtime.MacOs LVGLSharp.Runtime.MacOs NuGet Published on NuGet Early macOS runtime package with diagnostics and host scaffolding.
LVGLSharp.Runtime.Remote LVGLSharp.Runtime.Remote NuGet Published on NuGet Remote-session abstractions, frame transport, and VNC/RDP-oriented runtime pieces.
LVGLSharp.WPF LVGLSharp.WPF NuGet Published on NuGet WPF-like bootstrap and XAML runtime loader built on top of LVGLSharp.Forms and LVGLSharp.Runtime.Windows.
LVGLSharp.Analyzers LVGLSharp.Analyzers NuGet Published on NuGet Roslyn analyzers for runtime-package combinations and other repository constraints. 
<PropertyGroup>
  <TargetFrameworks>net10.0-windows;net10.0</TargetFrameworks>
</PropertyGroup>

<PropertyGroup Condition="'$(TargetFramework)' == 'net10.0-windows'">
  <UseWindowsForms>true</UseWindowsForms>
</PropertyGroup>

<PropertyGroup Condition="'$(TargetFramework)' == 'net10.0'">
  <UseLVGLSharpForms>true</UseLVGLSharpForms>
  <PublishAot>true</PublishAot>
</PropertyGroup>

ApplicationConfiguration.Initialize();
Application.Run(new MainForm());