/qbs-sgdebug

Qbs module for enabling various debug modes of the Qt Scene Graph's default renderer in your application

Primary LanguageQMLMIT LicenseMIT

qbs-sgdebug

Made by Ukrainian

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.

Installation

Get the module

$ mkdir 3rdParty
$ cd 3rdParty
$ git clone https://github.com/GooRoo/qbs-sgdebug.git

Add path to your root project

Project {
    qbsSearchPaths: '3rdParty/qbs-sgdebug'
}

Usage

Just add it as a dependency to your product and set the desired parameters:

CppApplication {
	Depends { name: 'scenegraphdebug' }

	scenegraphdebug.visualize: 'overdraw'
}

Available properties

  • logInfo. Possible values: true|false

    More information on QRhi is here. Sets QSG_RENDERER_DEBUG.

  • logStats. Possible values: true|false

    More information on performance is here. Sets QSG_RENDERER_DEBUG.

  • logTiming. Possible values: true|false

    More information on performance is here. Sets QSG_RENDER_TIMING.

  • colorizeAtlasTextures. Possible values: true|false

    More information on performance is here. Sets QSG_ATLAS_OVERLAY.

  • visualize. Possible values: 'batches'|'clip'|'changes'|'overdraw'

    More information on visualization is here. Sets QSG_VISUALIZE.

License

The module is distributed under the terms of MIT license.