The CMake build tool simplifies the build process for development projects across different platforms. It automatically generates build systems, such as Makefiles and Visual Studio project files.

CMake is a third-party tool with its own documentation. This topic describes how to use CMake with Qt Quick Ultralite.

Table of contents

• Getting Started with CMake
• CMake Reference
  • CMake Variable Reference

    QUL_ALLOW_DEPRECATED_CMAKE_API	Ignore deprecation warnings when using cmake functions and flags replaced by QmlProject
    QUL_BINARY_ASSET_OPTIONS	Lets you control how to include the binary asset data for the image resources
    QUL_BOARD_SDK_DIR	Path to the target platform Software Development Kit (SDK)
    QUL_COLOR_DEPTH	Bits of display color depth to build for.
    QUL_FREERTOS_HEAP_POLICY	Select FreeRTOS heap policy for app_target_setup_os.
    QUL_OS	Choose OS for app_* convenience functions.
    QUL_PLATFORM	Name of the platform to build for.
    QUL_PLATFORM_DEFAULT_LAYER_RENDERING_HINTS	The default rendering hint for the platform layer engine
    QUL_PLATFORM_DEFAULT_NUM_FRAMES_TO_PRESERVE_ASSETS	Default number of frames required to preserve assets in text cache
    QUL_PLATFORM_DEFAULT_TEXT_CACHE_ENABLED	The default status of text cache for the given platform
    QUL_PLATFORM_DEFAULT_TEXT_CACHE_SIZE	The default text cache size in bytes
    QUL_PLATFORM_DEVICELINK_ENABLED	Enables the device link component
    QUL_PLATFORM_PARTIAL_FRAMEBUFFER	If enabled the platform will adopt a partial framebuffer strategy.
    QUL_PLATFORM_RENDER_BATCH_HEIGHT	The render batch height for the given platform
    QUL_SOFTWARE_RASTERIZER_FREETYPE	Software support for vector graphics
    QUL_TARGET_TOOLCHAIN_DIR	Path to the target toolchain

    Deprecated CMake Variables list:

    QUL_DEBUG_BYTECODE	Adds JavaScript bytecode as comments into generated sources.
    QUL_DEBUG_LINE_DIRECTIVES	Adds #line directives into the generated sources.
    QUL_PLATFORM_DEFAULT_RESOURCE_COMPRESSED_LOSSLESS_PIXEL_FORMAT_ALPHA	The default pixel format for lossless compression of transparent image assets.
    QUL_PLATFORM_DEFAULT_RESOURCE_COMPRESSED_LOSSLESS_PIXEL_FORMAT_OPAQUE	The default pixel format for lossless compression of opaque image assets.
    QUL_PLATFORM_DEFAULT_RESOURCE_PIXEL_FORMAT_ALPHA	The default pixel format for transparent image assets.
    QUL_PLATFORM_DEFAULT_RESOURCE_PIXEL_FORMAT_OPAQUE	The default pixel format for opaque image assets.
    QUL_PLATFORM_REQUIRED_IMAGE_ALIGNMENT	The minimum alignment required for image data on the given platform.
    QUL_PLATFORM_REQUIRED_PIXEL_WIDTH_ALIGNMENT	The image width will be a multiple of this value on the given platform.

  • CMake Target Properties Reference (Deprecated)

    QUL_AUTO_GENERATE_GLYPHS	This option controls automatic glyph generation.
    QUL_COMPLEX_TEXT_RENDERING	Enables rendering complex scripts.
    QUL_CONTROLS_STYLE	Overrides the Controls style.
    QUL_DEFAULT_FONT_FAMILY	Default font family for Text elements.
    QUL_DEFAULT_FONT_QUALITY	Default font quality for Text elements.
    QUL_FONT_CACHE_PREALLOC	Controls preallocation of the font cache buffer.
    QUL_FONT_CACHE_PRIMING	Enable font cache priming.
    QUL_FONT_CACHE_SIZE	Set maximum cache size used by font engine.
    QUL_FONT_ENGINE	Enables provided font engine.
    QUL_FONT_FILES	List of paths of font files.
    QUL_FONT_FILES_RESOURCE_CACHE_POLICY	Configure copying of the application's font files to RAM for faster access.
    QUL_FONT_FILES_RESOURCE_RUNTIME_ALLOCATION_TYPE	Configure runtime allocation type used when copying the application
    QUL_FONT_FILES_RESOURCE_STORAGE_SECTION	Configure the resource storage section used for the application
    QUL_FONT_HEAP_PREALLOC	Controls preallocation of the heap buffer used by font engine.
    QUL_FONT_HEAP_SIZE	Set maximum heap size for the font engine.
    QUL_FONT_VECTOR_OUTLINES_DRAWING	Use vector outlines for text rendering.
    QUL_GLYPHS_RESOURCE_CACHE_POLICY	Configure copying of pre-rasterized glyph data to RAM for faster access.
    QUL_GLYPHS_RESOURCE_RUNTIME_ALLOCATION_TYPE	Configure runtime allocation type used when copying pre-rasterized glyph data to RAM.
    QUL_GLYPHS_RESOURCE_STORAGE_SECTION	Configure the resource storage section used for pre-rasterized glyph data.
    QUL_MAX_PARAGRAPH_SIZE	Set the maximum paragraph size.

  • CMake Source File Properties

    Deprecated source file properties list:

    QUL_RESOURCE_ALIGNMENT	Byte alignment for texture data
    QUL_RESOURCE_CACHE_POLICY	Define the image cache policy.
    QUL_RESOURCE_COMPRESSION	Store image in compressed format.
    QUL_RESOURCE_IMAGE_PIXEL_FORMAT	Set the preferred pixel format for the image.
    QUL_RESOURCE_OPTIMIZE_FOR_ROTATION	Enable optimizations for rotating the image at runtime.
    QUL_RESOURCE_OPTIMIZE_FOR_SCALE	Enable optimizations for scaling the image at runtime.
    QUL_RESOURCE_RUNTIME_ALLOCATION_TYPE	Define the asset runtime allocation type.
    QUL_RESOURCE_SPLIT_IMAGE_OPTIMIZATION	Enable optimization for splitting the image into opaque segments
    QUL_RESOURCE_STORAGE_SECTION	Define the asset storage section.

  • CMake Command Reference

    app_target_default_entrypoint	Adds a minimal entry point function to target
    app_target_setup_os	Set up target for platform OS.
    qul_add_target	Creates a Qt Quick Ultralite application target.
    qul_generate_flash_target	Generates a flash target for the application.
    qul_get_module_target	Get a Qt Quick Ultralite module target name.
    qul_override_freertos_heap_size	Overrides freeRTOS total heap size config

    Deprecated CMake Commands list:

    qul_add_qml_module	Creates a target for a QML module.
    qul_add_resource	Adds image resources to the target.
    qul_set_maximum_resource_cache_size	Sets the maximum resource cache size for a given runtime allocation type.
    qul_target_embed_translations	Embeds translations from .ts files.
    qul_target_generate_interfaces	Exposes the exported C
    qul_target_qml_sources	Adds QML source files to a target.