ferroui-win32 0.3.0

The Windows platform backend: windows, the message loop, input, screens and the software surface over the Win32 API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

//! 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.

// On a host that is not Windows the library holds the logic and no caller
// of it: the callers are the parts that call the system. The tests call it
// on every host.
#![cfg_attr(not(windows), allow(dead_code))]

pub mod automation;
pub mod d_composition;
pub mod direct_x;
pub mod input;
pub mod interop;
pub mod open_gl;
pub mod vulkan;
pub mod win32_com;
pub mod win_rt;

mod angle_options;
mod clipboard_format_registry;
mod cursor_factory;
mod framebuffer_manager;
mod i_blur_host;
mod i_windows_surface_factory;
mod icon_impl;
mod ole_data_object_helper;
mod ole_drag_source;
mod ole_drop_target;
mod ole_virtual_file_data;
mod swap_chain_top_level_impl;
mod sync_root;
mod win32_dispatcher_impl;
mod win32_gl_manager;
mod platform_constants;
mod win32_platform_options;
mod win32_platform_settings;
mod tray_icon_impl;
mod win32_native_control_host;
mod win32_storage_provider;
mod windows_mounted_volume_info_listener;
#[cfg(windows)]
mod windows_mounted_volume_info_provider;
mod win32_text_rendering;
mod win32_top_level_scene_info;
mod win32_type_extensions;
mod window_impl;
mod window_impl_app_wnd_proc;
mod window_impl_custom_caption_proc;

#[cfg(windows)]
mod clipboard_impl;
#[cfg(windows)]
mod data_transfer_to_ole_data_object_wrapper;
#[cfg(windows)]
mod drag_source;
#[cfg(windows)]
mod embedded_window_impl;
#[cfg(windows)]
mod offscreen_parent_window;
#[cfg(windows)]
mod ole_context;
#[cfg(windows)]
mod ole_data_object_to_data_transfer_item_wrapper;
#[cfg(windows)]
mod ole_data_object_to_data_transfer_wrapper;
#[cfg(all(windows, test))]
mod ole_tests;
#[cfg(windows)]
mod popup_impl;
#[cfg(windows)]
mod screen_impl;
#[cfg(windows)]
mod simple_window;
#[cfg(windows)]
mod win32_native_to_managed_menu_exporter;
#[cfg(windows)]
mod win32_platform;
#[cfg(windows)]
mod win_screen;
#[cfg(windows)]
pub mod wnd_proc_guard;

pub use angle_options::{AngleOptions, PlatformApi};
pub use cursor_factory::cursor_resource_id;
pub use platform_constants::{PlatformConstants, Version};
pub use win32_platform_options::{Win32CompositionMode, Win32DpiAwareness, Win32PlatformOptions, Win32RenderingMode};
pub use win32_top_level_scene_info::Win32TopLevelSceneInfo;
pub use win32_type_extensions::Win32TypeExtensions;
pub use swap_chain_top_level_impl::SwapChainTopLevelImpl;

#[cfg(windows)]
pub use clipboard_impl::ClipboardImpl;
#[cfg(windows)]
pub use cursor_factory::{CursorFactory, CursorImpl};
#[cfg(windows)]
pub use embedded_window_impl::EmbeddedWindowImpl;
#[cfg(windows)]
pub use framebuffer_manager::FramebufferManager;
#[cfg(windows)]
pub use icon_impl::IconImpl;
#[cfg(windows)]
pub use popup_impl::PopupImpl;
#[cfg(windows)]
pub use screen_impl::ScreenImpl;
#[cfg(windows)]
pub use win32_dispatcher_impl::Win32DispatcherImpl;
#[cfg(windows)]
pub use win32_platform::{Win32ApplicationExtensions, Win32Platform};
#[cfg(windows)]
pub use win32_platform_settings::Win32PlatformSettings;
#[cfg(windows)]
pub use win_screen::WinScreen;
#[cfg(windows)]
pub use window_impl::WindowImpl;

/// Fails for a member of the backend that a later stage builds: the message
/// names the member and the stage of `docs/porting/win32-platform.md`.
#[allow(dead_code)] // Nothing fails this way at present; the members of later stages do.
#[track_caller]
pub(crate) fn not_built(member: &str, stage: u32) -> ! {
    panic!("{member} is not built yet: it belongs to stage {stage} of the Windows platform backend (docs/porting/win32-platform.md)")
}