Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Offscreen OpenGL Qt QML renderer
https://github.com/node-3d/deps-qmlui-raub

binary dll graphics gui headers lib node-3d offscreen-rending opengl qml qt

Last synced: about 18 hours ago
JSON representation

Offscreen OpenGL Qt QML renderer

Host: GitHub
URL: https://github.com/node-3d/deps-qmlui-raub
Owner: node-3d
License: mit
Created: 2017-01-28T16:45:40.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2023-10-31T17:49:42.000Z (about 1 year ago)
Last Synced: 2024-11-11T10:48:35.622Z (9 days ago)
Topics: binary, dll, graphics, gui, headers, lib, node-3d, offscreen-rending, opengl, qml, qt
Language: C
Homepage: https://github.com/node-3d/node-3d
Size: 2.01 MB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # QmlUi binaries

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

[![NPM](https://badge.fury.io/js/deps-qmlui-raub.svg)](https://badge.fury.io/js/deps-qmlui-raub)

[![ESLint](https://github.com/node-3d/deps-qmlui-raub/actions/workflows/eslint.yml/badge.svg)](https://github.com/node-3d/deps-qmlui-raub/actions/workflows/eslint.yml)

[![Test](https://github.com/node-3d/deps-qmlui-raub/actions/workflows/test.yml/badge.svg)](https://github.com/node-3d/deps-qmlui-raub/actions/workflows/test.yml)

[![Cpplint](https://github.com/node-3d/deps-qmlui-raub/actions/workflows/cpplint.yml/badge.svg)](https://github.com/node-3d/deps-qmlui-raub/actions/workflows/cpplint.yml)

[![Build](https://github.com/node-3d/deps-qmlui-raub/actions/workflows/build.yml/badge.svg)](https://github.com/node-3d/deps-qmlui-raub/actions/workflows/build.yml)

```console

npm i -s deps-qmlui-raub

```

**OpenGL QML offscreen** renderer with **non-Qt C++ API**.

Uses [QQuickRenderControl](https://doc.qt.io/qt-6/qquickrendercontrol.html) 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 are prebuilt and then used as dependency package.

* Platforms (x64): Windows, Linux, Linux ARM, MacOS ARM.

* Library: QmlUi.

* Linking: static dll-type.

## 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('deps-qmlui-raub')` - 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.

binding.gyp

```javascript

  'variables': {

    'qt_core_bin': '

Preload libraries

```cpp

#ifdef __linux__

  #include 

#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

```

## 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.