Crate ferroui_win32 

ferroui-win32

The Windows platform backend: the windowing platform, the dispatcher over the message loop, windows, screens, cursors, the clipboard, input and the software surface, over the Win32 API.

The design, the file table and the stages are in docs/porting/win32-platform.md. What a stage has not built yet is absent, or fails with a message that names its stage: nothing stands in for it.

The crate compiles on every host. What calls the system is compiled for Windows only (cfg(windows)); the constants, the tables and the logic that reads messages and computes styles are compiled, and tested, everywhere.

Modules

automation

UI Automation: the provider side of the accessibility of Windows (the port of the reference’s automation project of the Windows backend, which is internal to the backend there too).

d_composition

DirectComposition: the COM interfaces (generated from dcomp.idl by the MicroCom generator in the build script of the crate), the structures the reference declares beside them, and the function that creates a device.

direct_x

Direct3D 11 and DXGI: the COM interfaces (generated from directx.idl by the MicroCom generator in the build script of the crate), the enumerations and structures the reference declares beside them, and the two functions that create a factory and a device.

input

Input of the Windows backend: the key tables, the devices, the input method of the system and its input pane.

interop

The declarations of the system the backend is written against.

open_gl

OpenGL on Windows: OpenGL ES through ANGLE (angle), and the OpenGL of the system through WGL.

vulkan

The Vulkan rendering mode of the platform: the loader of the system (vulkan-1.dll) and the surfaces of windows (VK_KHR_win32_surface).

win32_com

OLE data transfer, the shell and the input pane: the COM interfaces (generated from win32.idl by the MicroCom generator in the build script of the crate).

win_rt

The Windows Runtime: the COM interfaces (generated from winrt.idl by the MicroCom generator in the build script of the crate), string handles, activation, and the helpers the reference declares beside them.

Structs

AngleOptions

The options of the rendering mode that draws with OpenGL ES through ANGLE.

PlatformConstants

The constants of the platform.

SwapChainTopLevelImpl

A minimal top-level implementation that hosts a content tree on top of an externally managed swap-chain surface (e.g. a swap chain panel of another toolkit or any other host that supplies an OpenGL surface). Sizing, scaling and input pumping are driven by the host.

Version

A version of Windows: major, minor and build number, compared in that order.

Win32PlatformOptions

Platform-specific options which apply to Windows.

Win32TopLevelSceneInfo

An immutable bag with Win32-specific per-frame scene information, published via the platform-specific scene info of a top-level and consumed by render targets on the render thread.

Enums

PlatformApi

The Direct3D API ANGLE renders with.

Win32CompositionMode

Represents the Win32 window composition mode.

Win32DpiAwareness

Represents the DPI Awareness for the application.

Win32RenderingMode

Represents the rendering mode for platform graphics.

Traits

Win32TypeExtensions

The conversions of the structures of the system.

Functions

cursor_resource_id

The resource identifier of the system cursor for a standard cursor type (0 for no cursor).