https://github.com/gooroo/qbs-sgdebug
Qbs module for enabling various debug modes of the Qt Scene Graph's default renderer in your application
https://github.com/gooroo/qbs-sgdebug
debug qbs qbs-module qml qt scene-graph
Last synced: 8 months ago
JSON representation
Qbs module for enabling various debug modes of the Qt Scene Graph's default renderer in your application
- Host: GitHub
- URL: https://github.com/gooroo/qbs-sgdebug
- Owner: GooRoo
- License: mit
- Created: 2021-04-30T20:57:33.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-07-30T21:22:05.000Z (almost 4 years ago)
- Last Synced: 2025-02-11T18:10:00.771Z (over 1 year ago)
- Topics: debug, qbs, qbs-module, qml, qt, scene-graph
- Language: QML
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# qbs-sgdebug
[](https://github.com/GooRoo/ukrainian-shields)
This Qbs module allows you to debug your Qt Quick Scene Graph's default renderer with ease. It doesn't do any kind of magic—just sets some of the environment variables before you run your app with `qbs run`. I was too tired of doing this manually in my terminal over and over again.
For more information on the theory and techniques, please, refer to the [Qt Quick Scene Graph Default Renderer](https://doc.qt.io/qt-5/qtquick-visualcanvas-scenegraph-renderer.html).
## Installation
### Get the module
```sh
$ mkdir 3rdParty
$ cd 3rdParty
$ git clone https://github.com/GooRoo/qbs-sgdebug.git
```
### Add path to your root project
```qml
Project {
qbsSearchPaths: '3rdParty/qbs-sgdebug'
}
```
## Usage
Just add it as a dependency to your product and set the desired parameters:
```qml
CppApplication {
Depends { name: 'scenegraphdebug' }
scenegraphdebug.visualize: 'overdraw'
}
```
## Available properties
- **`logInfo`**. Possible values: `true`|`false`
More information on _QRhi_ is [here](https://doc.qt.io/qt-5/qtquick-visualcanvas-scenegraph-renderer.html#rendering-via-the-qt-rendering-hardware-interface). Sets `QSG_RENDERER_DEBUG`.
- **`logStats`**. Possible values: `true`|`false`
More information on _performance_ is [here](https://doc.qt.io/qt-5/qtquick-visualcanvas-scenegraph-renderer.html#performance). Sets `QSG_RENDERER_DEBUG`.
- **`logTiming`**. Possible values: `true`|`false`
More information on _performance_ is [here](https://doc.qt.io/qt-5/qtquick-visualcanvas-scenegraph-renderer.html#performance). Sets `QSG_RENDER_TIMING`.
- **`colorizeAtlasTextures`**. Possible values: `true`|`false`
More information on _performance_ is [here](https://doc.qt.io/qt-5/qtquick-visualcanvas-scenegraph-renderer.html#performance). Sets `QSG_ATLAS_OVERLAY`.
- **`visualize`**. Possible values: `'batches'`|`'clip'`|`'changes'`|`'overdraw'`
More information on _visualization_ is [here](https://doc.qt.io/qt-5/qtquick-visualcanvas-scenegraph-renderer.html#visualizing). Sets `QSG_VISUALIZE`.
# License
The module is distributed under the terms of [MIT license](LICENSE).