OverlayType

Overlay type is used to specify the purpose of an overlay, and act as a guide for the overlay system's operations.

Windowing systems commonly accept a window type specification which can aid in window management. For example, it can be used by the system to style the overlay appropriately.

Overlay types are extensible, and each I/O system can define their own set of types. Commonly used types such as dropdown or contextMenu are defined as a part of OverlayIO and can be found in OverlayIO.types. The io field specifies the I/O system, and the number field is used to distinguish between different types that the system has defined.

The special overlay type OverlayType.init with io set to null and number set to 0 is used to specify a general purpose overlay type with no extra specification.

@safe
struct OverlayType {}

Members

Variables

ioID
IOID ioID;

ID of the I/O system defining the overlay type.

number
int number;

Number representing the type of the overlay. Meaning of this field is defined by the I/O system, but usually it corresponds to an enum member, as it does for OverlayIO.

Meta