Struct luminvent_winit::window::WindowBuilder
source · [−]pub struct WindowBuilder {
pub window: WindowAttributes,
/* private fields */
}
Expand description
Object that allows you to build windows.
Fields
window: WindowAttributes
The attributes to use to create the window.
Implementations
sourceimpl WindowBuilder
impl WindowBuilder
sourcepub fn with_inner_size<S: Into<Size>>(self, size: S) -> Self
pub fn with_inner_size<S: Into<Size>>(self, size: S) -> Self
Requests the window to be of specific dimensions.
See Window::set_inner_size
for details.
sourcepub fn with_min_inner_size<S: Into<Size>>(self, min_size: S) -> Self
pub fn with_min_inner_size<S: Into<Size>>(self, min_size: S) -> Self
Sets a minimum dimension size for the window.
See Window::set_min_inner_size
for details.
sourcepub fn with_max_inner_size<S: Into<Size>>(self, max_size: S) -> Self
pub fn with_max_inner_size<S: Into<Size>>(self, max_size: S) -> Self
Sets a maximum dimension size for the window.
See Window::set_max_inner_size
for details.
sourcepub fn with_position<P: Into<Position>>(self, position: P) -> Self
pub fn with_position<P: Into<Position>>(self, position: P) -> Self
Sets a desired initial position for the window.
See WindowAttributes::position
for details.
sourcepub fn with_resizable(self, resizable: bool) -> Self
pub fn with_resizable(self, resizable: bool) -> Self
Sets whether the window is resizable or not.
See Window::set_resizable
for details.
sourcepub fn with_title<T: Into<String>>(self, title: T) -> Self
pub fn with_title<T: Into<String>>(self, title: T) -> Self
Requests a specific title for the window.
See Window::set_title
for details.
sourcepub fn with_fullscreen(self, fullscreen: Option<Fullscreen>) -> Self
pub fn with_fullscreen(self, fullscreen: Option<Fullscreen>) -> Self
Sets the window fullscreen state.
See Window::set_fullscreen
for details.
sourcepub fn with_maximized(self, maximized: bool) -> Self
pub fn with_maximized(self, maximized: bool) -> Self
Requests maximized mode.
See Window::set_maximized
for details.
sourcepub fn with_visible(self, visible: bool) -> Self
pub fn with_visible(self, visible: bool) -> Self
Sets whether the window will be initially hidden or visible.
See Window::set_visible
for details.
sourcepub fn with_transparent(self, transparent: bool) -> Self
pub fn with_transparent(self, transparent: bool) -> Self
Sets whether the background of the window should be transparent.
sourcepub fn with_decorations(self, decorations: bool) -> Self
pub fn with_decorations(self, decorations: bool) -> Self
Sets whether the window should have a border, a title bar, etc.
See Window::set_decorations
for details.
sourcepub fn with_always_on_top(self, always_on_top: bool) -> Self
pub fn with_always_on_top(self, always_on_top: bool) -> Self
Sets whether or not the window will always be on top of other windows.
See Window::set_always_on_top
for details.
sourcepub fn with_window_icon(self, window_icon: Option<Icon>) -> Self
pub fn with_window_icon(self, window_icon: Option<Icon>) -> Self
Sets the window icon.
See Window::set_window_icon
for details.
sourcepub fn build<T: 'static>(
self,
window_target: &EventLoopWindowTarget<T>
) -> Result<Window, OsError>
pub fn build<T: 'static>(
self,
window_target: &EventLoopWindowTarget<T>
) -> Result<Window, OsError>
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
sourceimpl Clone for WindowBuilder
impl Clone for WindowBuilder
sourcefn clone(&self) -> WindowBuilder
fn clone(&self) -> WindowBuilder
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for WindowBuilder
impl Debug for WindowBuilder
sourceimpl Default for WindowBuilder
impl Default for WindowBuilder
sourcefn default() -> WindowBuilder
fn default() -> WindowBuilder
Returns the “default value” for a type. Read more
sourceimpl WindowBuilderExtUnix for WindowBuilder
impl WindowBuilderExtUnix for WindowBuilder
fn with_x11_visual<T>(self, visual_infos: *const T) -> Self
fn with_x11_screen(self, screen_id: i32) -> Self
sourcefn with_class(self, instance: String, class: String) -> Self
fn with_class(self, instance: String, class: String) -> Self
Build window with WM_CLASS
hint; defaults to the name of the binary. Only relevant on X11.
sourcefn with_override_redirect(self, override_redirect: bool) -> Self
fn with_override_redirect(self, override_redirect: bool) -> Self
Build window with override-redirect flag; defaults to false. Only relevant on X11.
sourcefn with_x11_window_type(self, x11_window_types: Vec<XWindowType>) -> Self
fn with_x11_window_type(self, x11_window_types: Vec<XWindowType>) -> Self
Build window with _NET_WM_WINDOW_TYPE
hints; defaults to Normal
. Only relevant on X11.
sourcefn with_gtk_theme_variant(self, variant: String) -> Self
fn with_gtk_theme_variant(self, variant: String) -> Self
Build window with _GTK_THEME_VARIANT
hint set to the specified value. Currently only relevant on X11.
sourcefn with_resize_increments<S: Into<Size>>(self, increments: S) -> Self
fn with_resize_increments<S: Into<Size>>(self, increments: S) -> Self
Build window with resize increment hint. Only implemented on X11. Read more
sourcefn with_base_size<S: Into<Size>>(self, base_size: S) -> Self
fn with_base_size<S: Into<Size>>(self, base_size: S) -> Self
Build window with base size hint. Only implemented on X11. Read more
sourcefn with_app_id(self, app_id: String) -> Self
fn with_app_id(self, app_id: String) -> Self
Build window with a given application ID. It should match the .desktop
file distributed with
your program. Only relevant on Wayland. Read more
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more