# @node-3d/deps-qmlui

> Binaries and headers for QmlUi-dependent compilation

Latest version **5.0.1** (published 2026-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @node-3d/deps-qmlui
pnpm add @node-3d/deps-qmlui
yarn add @node-3d/deps-qmlui
bun add @node-3d/deps-qmlui
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.0.1 |
| Published | 2026-09-23 |
| First published | 2026-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22.18.0 |
| Dependencies | 2 |
| Unpacked size | 25.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 4 |
| Author | Luis Blanco |
| Maintainers | raub |
| Keywords | dependency, qmlui, gui, qml, qt, qt-qml, qtquick, binary, library, dll, lib, dylib, so, c++, addon, bindings, native, gyp |

## Links

- npm: https://www.npmjs.com/package/@node-3d/deps-qmlui
- Repository: https://github.com/node-3d/deps-qmlui
- Homepage: https://github.com/node-3d/node-3d#readme
- Issues: https://github.com/node-3d/node-3d/issues
- npm.io page: https://npm.io/package/@node-3d/deps-qmlui

## Dependencies (2)

- [@node-3d/addon-tools](https://npm.io/package/@node-3d/addon-tools.md) ~10.1.0
- [@node-3d/deps-qt-qml](https://npm.io/package/@node-3d/deps-qt-qml.md) ~5.0.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 5.0.1 (latest) — 2026-09-23
- 5.0.0 — 2026-08-15

## README

# QmlUi binaries and headers

This is a part of [Node3D](https://github.com/node-3d) project.

[![NPM](https://badge.fury.io/js/@node-3d%2Fdeps-qmlui.svg)](https://badge.fury.io/js/@node-3d%2Fdeps-qmlui)
[![Lint](https://github.com/node-3d/deps-qmlui/actions/workflows/lint.yml/badge.svg)](https://github.com/node-3d/deps-qmlui/actions/workflows/lint.yml)
[![Test](https://github.com/node-3d/deps-qmlui/actions/workflows/test.yml/badge.svg)](https://github.com/node-3d/deps-qmlui/actions/workflows/test.yml)
[![Cpplint](https://github.com/node-3d/deps-qmlui/actions/workflows/cpplint.yml/badge.svg)](https://github.com/node-3d/deps-qmlui/actions/workflows/cpplint.yml)
[![Build](https://github.com/node-3d/deps-qmlui/actions/workflows/build.yml/badge.svg)](https://github.com/node-3d/deps-qmlui/actions/workflows/build.yml)

```bash
npm install @node-3d/deps-qmlui
```



**OpenGL QML offscreen** renderer with **non-Qt C++ API**.
Uses [QQuickRenderControl](https://doc.qt.io/qt-6/qquickrendercontrol.html) (**Qt 6.8.0**) to render QML
scenes to textures. The QML renderer has a separate OpenGL context, so
[resource sharing](https://www.glfw.org/docs/3.4/context_guide.html#context_sharing) is used.

Binaries and headers are prebuilt and then used as dependency package.

* Platforms: Windows x64, Linux x64/ARM64, macOS x64/ARM64.
* Library: QmlUi.
* Linking: static dll-type.

## Windows ARM64 support

Windows ARM64 is not currently supported by this package.

QmlUi renders QML into an OpenGL FBO from a Qt-owned `QOpenGLContext` that shares resources
with Node3D's existing OpenGL context, then returns the resulting OpenGL texture
ID to Node3D. That contract requires a real OpenGL API surface, Qt's OpenGL
rendering path, and a Qt OpenGL module build.

The Qt 6.8.0 Windows ARM64 desktop package used by the release workflow does not
expose the `opengl` qmake module required by QmlUi's build.


## Common workflow

1. Create a window and initialize OpenGL context.
1. Call `QmlUi::init2(...)` to create the QML rendering surface (and its shared OpenGL context).
1. Instantiate `QmlUi` and load a QML scene.
1. Receive an OpenGL texture ID and use it somehow.
1. Send/receive input and other events.

See [QmlUi header](include/qml-ui.hpp) for more details.


## Building addons

Requiring this module on Windows - `require('@node-3d/deps-qmlui')` - adds Qt's DLL
location to ENV PATH. On Unix this does nothing, as library directories are not in ENV PATH.
The paths for Unix have to be compiled into the node-addon with `rpath` option.

<details>

<summary><b>binding.gyp</b></summary>

```javascript
  'variables': {
    'bin': '<!(node -p "require(\'@node-3d/addon-tools\').getBin()")',
    'qt_core_bin': '<!(node -p "require(\'@node-3d/deps-qmlui\').core.bin")',
    'qt_gui_bin': '<!(node -p "require(\'@node-3d/deps-qmlui\').gui.bin")',
    'qt_qml_bin': '<!(node -p "require(\'@node-3d/deps-qmlui\').qml.bin")',
    'qmlui_include': '<!(node -p "require(\'@node-3d/deps-qmlui\').include")',
    'qmlui_bin': '<!(node -p "require(\'@node-3d/deps-qmlui\').bin")',
  },
  ...
  'targets': [
    {
      'target_name': '...',
      
      'include_dirs': [
        '<(qmlui_include)',
      ],
      
      'library_dirs': [ '<(qmlui_bin)' ],
      'libraries'    : [ '-lqmlui' ],
      
      'conditions': [
        
        ['OS=="linux"', {
          'libraries': [
            "-Wl,-rpath,'$$ORIGIN'",
            "-Wl,-rpath,'$$ORIGIN/../node_modules/@node-3d/deps-qt-core/<(bin)'",
            "-Wl,-rpath,'$$ORIGIN/../node_modules/@node-3d/deps-qt-gui/<(bin)'",
            "-Wl,-rpath,'$$ORIGIN/../node_modules/@node-3d/deps-qt-qml/<(bin)'",
            "-Wl,-rpath,'$$ORIGIN/../node_modules/@node-3d/deps-qmlui/<(bin)'",
            "-Wl,-rpath,'$$ORIGIN/../../@node-3d/deps-qt-core/<(bin)'",
            "-Wl,-rpath,'$$ORIGIN/../../@node-3d/deps-qt-gui/<(bin)'",
            "-Wl,-rpath,'$$ORIGIN/../../@node-3d/deps-qt-qml/<(bin)'",
            "-Wl,-rpath,'$$ORIGIN/../../@node-3d/deps-qmlui/<(bin)'",
          ],
        }],
        
        ['OS=="mac"', {
          'libraries': [
            '<(qmlui_bin)/libqmlui.dylib',
            '-Wl,-rpath,@loader_path',
            '-Wl,-rpath,@loader_path/../node_modules/@node-3d/deps-qt-core/<(bin)',
            '-Wl,-rpath,@loader_path/../node_modules/@node-3d/deps-qt-gui/<(bin)',
            '-Wl,-rpath,@loader_path/../node_modules/@node-3d/deps-qt-qml/<(bin)',
            '-Wl,-rpath,@loader_path/../node_modules/@node-3d/deps-qmlui/<(bin)',
            '-Wl,-rpath,@loader_path/../../@node-3d/deps-qt-core/<(bin)',
            '-Wl,-rpath,@loader_path/../../@node-3d/deps-qt-gui/<(bin)',
            '-Wl,-rpath,@loader_path/../../@node-3d/deps-qt-qml/<(bin)',
            '-Wl,-rpath,@loader_path/../../@node-3d/deps-qmlui/<(bin)',
          ],
        }],
        
        ['OS=="win"', {
          'libraries': [ '-lqmlui' ],
        }],
        
      ],
    },
```

</details>

<details>

<summary><b>Preload libraries</b></summary>

```cpp
#ifdef __linux__
  #include <dlfcn.h>
#endif

  // ... inside some kind of init() function
  #ifdef __linux__
  dlopen("libicui18n.so.73", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libicuuc.so.73", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libicudata.so.73", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libicuio.so.73", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libicule.so.73", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libicutu.so.73", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6Core.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6Network.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6DBus.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6Gui.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6OpenGL.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6Widgets.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6XcbQpa.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6Qml.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6Quick.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6QuickControls2.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6QuickTemplates2.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libQt6QuickWidgets.so.6", RTLD_NOW | RTLD_GLOBAL);
  dlopen("libqmlui.so", RTLD_NOW | RTLD_GLOBAL);
  #endif
```

</details>


## Legal notice

This software uses the [Qt library](https://www.qt.io/).
Qt is legally used under the LGPLv3 (GNU Lesser General Public License) version.
It is [explicitly stated](https://www.qt.io/licensing/open-source-lgpl-obligations)
that Qt Libraries can be used in a commercial closed-source app (if you wish):

> In case of dynamic linking, it is possible, but not mandatory,
to keep application source code proprietary as long as it is
“work that uses the library” – typically achieved
via dynamic linking of the library.

These **terms and conditions** allow using (unmodified) Qt as a
shared library (DLL), in a closed-source project.

Qt licensing information (a copy) is given in a [separate file](QT_LGPL),
which also can be found on
[Qt's official web-site](http://doc.qt.io/qt-6/lgpl.html).

---

The rest of this package is MIT licensed.

## Binary Origin

Release archives are built by this repository's public GitHub Actions workflows.

Attestations: https://github.com/node-3d/deps-qmlui/attestations

To verify a downloaded archive:

```bash
gh release download <tag> -R node-3d/deps-qmlui -p <platform>.gz
gh attestation verify <platform>.gz -R node-3d/deps-qmlui
```

---
_Source: https://npm.io/package/@node-3d/deps-qmlui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
