Definitions in screen.h

Updated: October 26, 2022

Preprocessor macro definitions for the screen.h header file in the libscreen library

Definitions:

#include <screen/screen.h>
#define _SCREEN_MAKE_VERSION (((major) * 10000) + ((minor) * 100) + (patch))

Convenience macro to facilitate comparison of Screen versions.

#define _SCREEN_VERSION_MAJOR 3

The major version number.

A difference in the major version number implies that the Screen API isn't backwards compatible (e.g., A Screen application that's developed using Screen version 2.0.0 can't run on a target that's running Screen versio 1.0.0.).

#define _SCREEN_VERSION_MINOR 1

The minor version number.

A difference in the minor version number implies that there may be differences in the Screen API, but the changes are backwards compatible (e.g., A Screen application that's developed using Screen version 2.1.0 can run on a target that's running Screen version 2.0.0.).

#define _SCREEN_VERSION_PATCH 0

The patch version number.

A difference in the patch version number implies no differences in the Screen API; the changes are implementation updates only(e.g., A Screen application that's developed using Screen version 2.1.0 uses the same Screen API as one from Screen version 2.1.1.).

#define _SCREEN_VERSION _SCREEN_MAKE_VERSION(_SCREEN_VERSION_MAJOR, _SCREEN_VERSION_MINOR, _SCREEN_VERSION_PATCH)

The current version of Screen.

Screen version 2.0.0 indicates compatibility with QNX SDP 7.0. Screen version 3.0.0 indicates compatibility with QNX SDP 7.1.

#define SCREEN_PROPERTY_WINDOW_MANAGER_ID SCREEN_PROPERTY_WINDOW_MANAGER_ID

The feature preprocessor definition that indicates the definition of the SCREEN_PROPERTY_WINDOW_MANAGER_ID property.

For more information on this property, see Screen property types.

#define screen_register_window_manager screen_register_window_manager

The feature preprocessor definition that indicates the declaration of screen_register_window_manager().

This function allows the abilities for a context to register and unregister itself as the window manager of a display. For more information, see screen_register_window_manager().

#define screen_register_event screen_register_event

The feature preprocessor definition that indicates the definition of screen_register_event().

This function handles registering sigevents so that screen_notify() can work as intended on 7.1 or connections with _NTO_COF_REG_EVENTS. For more information, see screen_register_event().

#define SCREEN_DISPLAY_TYPE_DSI SCREEN_DISPLAY_TYPE_DSI

The feature preprocessor definition that indicates the definition of a connection type that's used to identify a MIPI DSI connection to the display.

For more information, see SCREEN_DISPLAY_TYPE_DSI of Screen display types.

#define SCREEN_FORMAT_NV16 SCREEN_FORMAT_NV16

The feature preprocessor definition that indicates the definition of a pixel format with an 8-bit Y plane, 2x1-subsampled, and interleaved U and V planes.

For more information, see SCREEN_FORMAT_NV16 of Screen pixel format types.

#define SCREEN_USAGE_PHYSICAL SCREEN_USAGE_PHYSICAL

The feature preprocessor definition that indicates the definition of a flag to suggest to Screen that your buffer should be physically contiguous and the physical address should be provided.

For more information, see SCREEN_USAGE_PHYSICAL of Screen usage flag types.

#define SCREEN_ACQUIRE_AND_RELEASE_OTHERS SCREEN_ACQUIRE_AND_RELEASE_OTHERS

The feature preprocessor definition that indicates the definition of a flag to atomically release all other buffers when a new one is acquired when you call screen_acquire_buffer().

For more information, see SCREEN_ACQUIRE_AND_RELEASE_OTHERS of Screen acquire buffer flags.

#define SCREEN_ACQUIRE_DONT_BLOCK SCREEN_ACQUIRE_DONT_BLOCK

The feature preprocessor definition that indicates the definition of a flag to return from the function immediately if no buffer is available when you call screen_acquire_buffer().

For more information, see SCREEN_ACQUIRE_DONT_BLOCK of Screen acquire buffer flags.

#define screen_create_window_from_class screen_create_window_from_class

The feature preprocessor definition that indicates the declaration of screen_create_window_from_class().

This function allows the ability to create a window whose properties will be based on a class that you've defined in your graphics configuration file. For more information, see screen_create_window_from_class().

#define SCREEN_PROPERTY_FD SCREEN_PROPERTY_FD

The feature preprocessor definition that indicates the definition of the SCREEN_PROPERTY_FD property.

For more information on this property, see Screen property types.

#define SCREEN_NOTIFY_DISPLAY SCREEN_NOTIFY_DISPLAY

The feature preprocessor definition that indicates the definition of the SCREEN_NOTIFY_DISPLAY notification type.

For more information on this notification type, see Screen notification types.

#define SCREEN_FORMAT_P010 SCREEN_FORMAT_P010

The feature preprocessor definition that indicates the definition of a pixel format with 16-bit Y plane (10-bit effective), 2x1-subsampled, and interleaved U and V planes.

For more information, see the SCREEN_FORMAT_P010 of Screen pixel format types.

#define SCREEN_FORMAT_BGRA8888 SCREEN_FORMAT_BGRA8888

The feature preprocessor definition that indicates the definition of a pixel format with 8-bit per color component with swapped R and B channels.

For more information, see the SCREEN_FORMAT_BGRA8888 of Screen pixel format types.

#define SCREEN_FORMAT_BGRX8888 SCREEN_FORMAT_BGRX8888

The feature preprocessor definition that indicates the definition of a pixel format with 8-bit per color component with swapped R and B channels.

For more information, see the SCREEN_FORMAT_BGRX8888 of Screen pixel format types.

#define SCREEN_FORMAT_RGBA1010102 SCREEN_FORMAT_RGBA1010102

The feature preprocessor definition that indicates the definition of a four-component, 32-bit unsigned integer format that supports 10 bits for each color and 2 bits for alpha.

For more information, see the SCREEN_FORMAT_RGBA1010102 of Screen pixel format types.

#define SCREEN_FORMAT_RGBX1010102 SCREEN_FORMAT_RGBX1010102

The feature preprocessor definition that indicates the definition of a four-component, 32-bit unsigned integer format that supports 10 bits for each color and 2 unused bits.

For more information, see the SCREEN_FORMAT_RGBX1010102 of Screen pixel format types.

#define SCREEN_FORMAT_BGRA1010102 SCREEN_FORMAT_BGRA1010102

The feature preprocessor definition that indicates the definition of a four-component, 32-bit unsigned integer format that supports 10 bits for each color and 2 bits for alpha.

For more information, see the SCREEN_FORMAT_BGRA1010102 of Screen pixel format types.

#define SCREEN_FORMAT_BGRX1010102 SCREEN_FORMAT_BGRX1010102

The feature preprocessor definition that indicates the definition of a four-component, 32-bit unsigned integer format that supports 10 bits for each color and 2 unused bits.

For more information, see the SCREEN_FORMAT_BGRX1010102 of Screen pixel format types.

#define SCREEN_USAGE_VULKAN SCREEN_USAGE_VULKAN

The feature preprocessor definition that indicates the definition of a flag informing Screen that the buffer will be rendered using Vulkan.

For more information, see the SCREEN_USAGE_VULKAN of Screen usage flag types.

#define SCREEN_MODE_PREFERRED_INDEX (-1)

Defines the mode preferred index.

Used as a convenience value when using screen_set_display_property_iv() to set the SCREEN_PROPERTY_MODE property. When you use this value, Screen uses the default video mode without you having to first determine all the modes supported by the display to find the one with SCREEN_MODE_PREFERRED set in flags.

#define SCREEN_INVALID_ID (-1)

The value of the SCREEN_PROPERTY_WINDOW_MANAGER_ID property of a display object when there's no window manager associated with it.

Library:

libscreen