C

Qul Namespace

Provides types and declarations specific to Qt Quick Ultralite and miscellaneous functions related to application life cycle. More...

Header: #include <>

Namespaces

namespace Platform
namespace PlatformInterface

Classes

class Application
class EventQueue
struct Image
struct ImageProvider
struct ImageWriteGuard
struct ListModel
class Object
struct Property
struct RootItem
struct SharedImage
struct Signal
struct Singleton
class Timer

Types

enum EventQueueOverrunPolicy { EventQueueOverrunPolicy_Discard, EventQueueOverrunPolicy_OverwriteOldest }
enum PixelFormat { PixelFormat_ARGB32_Premultiplied, PixelFormat_ARGB32, PixelFormat_RGB32, PixelFormat_RGB16, PixelFormat_Alpha8 }
typedef qreal

Functions

void appMain(const void *arg = 0)
void initPlatform()

Detailed Description

Classes

class Application

The Application class is used to start Qt Quick Ultralite. More...

class EventQueue

Provides a convenient way to send and receive events across different parts of the application. More...

class Image

An image representation that allows direct access to the pixel data. More...

class ImageProvider

The ImageProvider class provides an interface for supporting image requests in QML. More...

class ImageWriteGuard

A helper for calling Image::beginWrite() and Image::endWrite(). More...

class ListModel

Inherit from this class to expose a model to QML. More...

class Object

Provides abstract implementation for all items or objects used in Qt Quick Ultralite. More...

class Property

The Property class can be used to hold a property of a given type. More...

class RootItem

The RootItem class is a public type used in Application::setRootItem(). More...

class SharedImage

Shared reference to image data. More...

class Signal

Allows creating a signal that can be connected from QML. More...

class Singleton

Inherit from this class to expose the C++ class or struct to the QML as a singleton. More...

class Timer

Provides a way to run repetitive and single-shot timers. More...

Type Documentation

enum Qul::EventQueueOverrunPolicy

Defines what happens when an event is posted to a EventQueue and the queue is already full.

ConstantValueDescription
Qul::EventQueueOverrunPolicy_Discard0If the queue is full, the posted event will be discarded.
Qul::EventQueueOverrunPolicy_OverwriteOldest1If the queue is full, the posted event will overwrite the oldest existing event in the queue. The overwritten event is lost.

enum Qul::PixelFormat

This enum specifies the pixel format used in an area of memory.

Note: Not all pixel formats are supported on all platforms.

ConstantValueDescription
Qul::PixelFormat_ARGB32_Premultiplied1Supported on all platforms.
Qul::PixelFormat_ARGB320Supported on STM32 and NXP.
Qul::PixelFormat_RGB322Usually supported only when color depth is 32 bits.
Qul::PixelFormat_RGB164Usually supported only when color depth is 16 bits.
Qul::PixelFormat_Alpha85Supported on all platforms.

typedef Qul::qreal

Typedef for double unless Qt Quick Ultralite runtime is built with QUL_QREAL_SINGLEPRECISION CMake option.

Function Documentation

void Qul::appMain(const void *arg = 0)

This function initializes and also acts as a main loop for Qt Quick Ultralite application. This function never exits. arg is not used.

Platform hardware needs to be initialized before calling this function.

This function is called implicitly as part of default entry point implementation if app_target_default_main is used.

This function was introduced in Qt Quick Ultralite 1.0.

See also initPlatform and Entry point to Qt Quick Ultralite application.

void Qul::initPlatform()

Initialize Board Support Package (BSP).

This function must be called before Qt Quick Ultralite is initialized to operate correctly.

It's up to application developer on how and when this function will be called. Typically it's called just before appMain, but developer may also decide not call it all and perform own BSP initialization.

This function is called implicitly as part of default entry point implementation if app_target_default_main is used.

This function was introduced in Qt Quick Ultralite 1.0.

See also appMain and Entry point to Qt Quick Ultralite application.

Available under certain Qt licenses.
Find out more.