Struct winit::window::WindowBuilder [−][src]
pub struct WindowBuilder { pub window: WindowAttributes, // some fields omitted }
Expand description
Object that allows you to build windows.
Fields
window: WindowAttributes
Expand description
The attributes to use to create the window.
Implementations
impl WindowBuilder
[src]
impl WindowBuilder
[src]pub fn with_inner_size<S: Into<Size>>(self, size: S) -> Self
[src]
pub fn with_inner_size<S: Into<Size>>(self, size: S) -> Self
[src]Requests the window to be of specific dimensions.
See Window::set_inner_size
for details.
pub fn with_min_inner_size<S: Into<Size>>(self, min_size: S) -> Self
[src]
pub fn with_min_inner_size<S: Into<Size>>(self, min_size: S) -> Self
[src]Sets a minimum dimension size for the window.
See Window::set_min_inner_size
for details.
pub fn with_max_inner_size<S: Into<Size>>(self, max_size: S) -> Self
[src]
pub fn with_max_inner_size<S: Into<Size>>(self, max_size: S) -> Self
[src]Sets a maximum dimension size for the window.
See Window::set_max_inner_size
for details.
pub fn with_position<P: Into<Position>>(self, position: P) -> Self
[src]
pub fn with_position<P: Into<Position>>(self, position: P) -> Self
[src]Sets a desired initial position for the window.
See WindowAttributes::position
for details.
pub fn with_resizable(self, resizable: bool) -> Self
[src]
pub fn with_resizable(self, resizable: bool) -> Self
[src]Sets whether the window is resizable or not.
See Window::set_resizable
for details.
pub fn with_title<T: Into<String>>(self, title: T) -> Self
[src]
pub fn with_title<T: Into<String>>(self, title: T) -> Self
[src]Requests a specific title for the window.
See Window::set_title
for details.
pub fn with_fullscreen(self, fullscreen: Option<Fullscreen>) -> Self
[src]
pub fn with_fullscreen(self, fullscreen: Option<Fullscreen>) -> Self
[src]Sets the window fullscreen state.
See Window::set_fullscreen
for details.
pub fn with_maximized(self, maximized: bool) -> Self
[src]
pub fn with_maximized(self, maximized: bool) -> Self
[src]Requests maximized mode.
See Window::set_maximized
for details.
pub fn with_visible(self, visible: bool) -> Self
[src]
pub fn with_visible(self, visible: bool) -> Self
[src]Sets whether the window will be initially hidden or visible.
See Window::set_visible
for details.
pub fn with_transparent(self, transparent: bool) -> Self
[src]
pub fn with_transparent(self, transparent: bool) -> Self
[src]Sets whether the background of the window should be transparent.
pub fn with_decorations(self, decorations: bool) -> Self
[src]
pub fn with_decorations(self, decorations: bool) -> Self
[src]Sets whether the window should have a border, a title bar, etc.
See Window::set_decorations
for details.
pub fn with_always_on_top(self, always_on_top: bool) -> Self
[src]
pub fn with_always_on_top(self, always_on_top: bool) -> Self
[src]Sets whether or not the window will always be on top of other windows.
See Window::set_always_on_top
for details.
pub fn with_window_icon(self, window_icon: Option<Icon>) -> Self
[src]
pub fn with_window_icon(self, window_icon: Option<Icon>) -> Self
[src]Sets the window icon.
See Window::set_window_icon
for details.
pub fn build<T: 'static>(
self,
window_target: &EventLoopWindowTarget<T>
) -> Result<Window, OsError>
[src]
pub fn build<T: 'static>(
self,
window_target: &EventLoopWindowTarget<T>
) -> Result<Window, OsError>
[src]Builds the window.
Possible causes of error include denied permission, incompatible system, and lack of memory.
Platform-specific behavior:
- Web: The window is created but not inserted into the web page automatically. Please see the web platform module for more information.
Trait Implementations
impl Clone for WindowBuilder
[src]
impl Clone for WindowBuilder
[src]fn clone(&self) -> WindowBuilder
[src]
fn clone(&self) -> WindowBuilder
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for WindowBuilder
[src]
impl Debug for WindowBuilder
[src]impl Default for WindowBuilder
[src]
impl Default for WindowBuilder
[src]fn default() -> WindowBuilder
[src]
fn default() -> WindowBuilder
[src]Returns the “default value” for a type. Read more
impl WindowBuilderExtWindows for WindowBuilder
[src]
impl WindowBuilderExtWindows for WindowBuilder
[src]fn with_parent_window(self, parent: HWND) -> WindowBuilder
[src]
fn with_parent_window(self, parent: HWND) -> WindowBuilder
[src]Sets a parent to the window to be created. Read more
fn with_owner_window(self, parent: HWND) -> WindowBuilder
[src]
fn with_owner_window(self, parent: HWND) -> WindowBuilder
[src]Set an owner to the window to be created. Can be used to create a dialog box, for example.
Can be used in combination with WindowExtWindows::set_enable(false)
on the owner window to create a modal dialog box. Read more
fn with_menu(self, menu: HMENU) -> WindowBuilder
[src]
fn with_menu(self, menu: HMENU) -> WindowBuilder
[src]Sets a menu on the window to be created. Read more
fn with_taskbar_icon(self, taskbar_icon: Option<Icon>) -> WindowBuilder
[src]
fn with_taskbar_icon(self, taskbar_icon: Option<Icon>) -> WindowBuilder
[src]This sets ICON_BIG
. A good ceiling here is 256x256.
fn with_no_redirection_bitmap(self, flag: bool) -> WindowBuilder
[src]
fn with_no_redirection_bitmap(self, flag: bool) -> WindowBuilder
[src]This sets WS_EX_NOREDIRECTIONBITMAP
.
fn with_drag_and_drop(self, flag: bool) -> WindowBuilder
[src]
fn with_drag_and_drop(self, flag: bool) -> WindowBuilder
[src]Enables or disables drag and drop support (enabled by default). Will interfere with other crates
that use multi-threaded COM API (CoInitializeEx
with COINIT_MULTITHREADED
instead of
COINIT_APARTMENTTHREADED
) on the same thread. Note that winit may still attempt to initialize
COM API regardless of this option. Currently only fullscreen mode does that, but there may be more in the future.
If you need COM API with COINIT_MULTITHREADED
you must initialize it before calling any winit functions.
See https://docs.microsoft.com/en-us/windows/win32/api/objbase/nf-objbase-coinitialize#remarks for more information. Read more
fn with_theme(self, theme: Option<Theme>) -> WindowBuilder
[src]
fn with_theme(self, theme: Option<Theme>) -> WindowBuilder
[src]Forces a theme or uses the system settings if None
was provided.
Auto Trait Implementations
impl RefUnwindSafe for WindowBuilder
impl Send for WindowBuilder
impl !Sync for WindowBuilder
impl Unpin for WindowBuilder
impl UnwindSafe for WindowBuilder
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more