Struct Window 

pub struct Window<S> { /* private fields */ }

Owned window handle.

Dropping the handle destroys the window.

Implementations

impl<S> Window<S>

pub fn new<F>( window_type: WindowType, state: S, wndproc: F, ) -> Result<Self, WindowCreationError>

where F: Fn(Pin<&S>, WindowMessage) -> Option<LRESULT> + 'static,

Creates a new window with a wndproc closure.

The state parameter will be allocated alongside the closure. It is meant as a convenient alternative to Rc<State> to access variables from both inside and outside the closure. A pinned reference to the state is passed as the first parameter to the closure. Use Window::state() to access the state from the outside.

pub fn new_ex<F>( window_type: WindowType, ex_style: WINDOW_EX_STYLE, state: S, wndproc: F, ) -> Result<Self, WindowCreationError>

where F: Fn(Pin<&S>, WindowMessage) -> Option<LRESULT> + 'static,

Same as Window::new() but allows specifying extended window styles (the dwExStyle parameter of CreateWindowExA), such as WS_EX_NOREDIRECTIONBITMAP.

pub fn new_checked<F>( window_type: WindowType, state: S, wndproc: F, ) -> Result<Self, WindowCreationError>

where F: FnMut(Pin<&S>, WindowMessage) -> Option<LRESULT> + 'static,

Same as Window::new() but allows the closure to be FnMut.

Internally uses a RefCell for the closure to prevent it from being re-entered by nested message loops (e.g., from modal dialogs). Forwards nested messages to the default wndproc procedure.

pub fn new_checked_ex<F>( window_type: WindowType, ex_style: WINDOW_EX_STYLE, state: S, wndproc: F, ) -> Result<Self, WindowCreationError>

where F: FnMut(Pin<&S>, WindowMessage) -> Option<LRESULT> + 'static,

Same as Window::new_checked() but allows specifying extended window styles (the dwExStyle parameter), such as WS_EX_NOREDIRECTIONBITMAP. See Window::new_ex().

pub fn hwnd(&self) -> HWND

Returns this window’s raw window handle.

pub fn state(&self) -> Pin<&S>

Returns a reference to the state shared with the wndproc closure.

Trait Implementations

impl<S: Debug> Debug for Window<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Drop for Window<S>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.