Struct winit::WindowBuilder
[−]
[src]
pub struct WindowBuilder { pub window: WindowAttributes, // some fields omitted }
Object that allows you to build windows.
Fields
window: WindowAttributes
The attributes to use to create the window.
Methods
impl WindowBuilder
[src]
pub fn new() -> WindowBuilder
[src]
Initializes a new WindowBuilder
with default values.
pub fn with_dimensions(self, width: u32, height: u32) -> WindowBuilder
[src]
Requests the window to be of specific dimensions.
Width and height are in pixels.
pub fn with_min_dimensions(self, width: u32, height: u32) -> WindowBuilder
[src]
Sets a minimum dimension size for the window
Width and height are in pixels.
pub fn with_max_dimensions(self, width: u32, height: u32) -> WindowBuilder
[src]
Sets a maximum dimension size for the window
Width and height are in pixels.
pub fn with_title<T: Into<String>>(self, title: T) -> WindowBuilder
[src]
Requests a specific title for the window.
pub fn with_fullscreen(self, monitor: Option<MonitorId>) -> WindowBuilder
[src]
Sets the window fullscreen state. None means a normal window, Some(MonitorId) means a fullscreen window on that specific monitor
pub fn with_maximized(self, maximized: bool) -> WindowBuilder
[src]
Requests maximized mode.
pub fn with_visibility(self, visible: bool) -> WindowBuilder
[src]
Sets whether the window will be initially hidden or visible.
pub fn with_transparency(self, transparent: bool) -> WindowBuilder
[src]
Sets whether the background of the window should be transparent.
pub fn with_decorations(self, decorations: bool) -> WindowBuilder
[src]
Sets whether the window should have a border, a title bar, etc.
pub fn with_always_on_top(self, always_on_top: bool) -> WindowBuilder
[src]
Sets whether or not the window will always be on top of other windows.
pub fn with_window_icon(self, window_icon: Option<Icon>) -> WindowBuilder
[src]
Sets the window icon. On Windows and X11, this is typically the small icon in the top-left corner of the titlebar.
Platform-specific
This only has an effect on Windows and X11.
On Windows, this sets ICON_SMALL
. The base size for a window icon is 16x16, but it's
recommended to account for screen scaling and pick a multiple of that, i.e. 32x32.
X11 has no universal guidelines for icon sizes, so you're at the whims of the WM. That said, it's usually in the same ballpark as on Windows.
pub fn with_multitouch(self) -> WindowBuilder
[src]
Enables multitouch.
pub fn build(self, events_loop: &EventsLoop) -> Result<Window, CreationError>
[src]
Builds the window.
Error should be very rare and only occur in case of permission denied, incompatible system, out of memory, etc.
Trait Implementations
impl WindowBuilderExt for WindowBuilder
[src]
fn with_x11_visual<T>(self, visual_infos: *const T) -> WindowBuilder
[src]
fn with_x11_screen(self, screen_id: i32) -> WindowBuilder
[src]
fn with_class(self, instance: String, class: String) -> WindowBuilder
[src]
Build window with WM_CLASS
hint; defaults to the name of the binary. Only relevant on X11.
fn with_override_redirect(self, override_redirect: bool) -> WindowBuilder
[src]
Build window with override-redirect flag; defaults to false. Only relevant on X11.
fn with_x11_window_type(self, x11_window_type: XWindowType) -> WindowBuilder
[src]
Build window with _NET_WM_WINDOW_TYPE
hint; defaults to Normal
. Only relevant on X11.
fn with_resize_increments(
self,
width_inc: u32,
height_inc: u32
) -> WindowBuilder
[src]
self,
width_inc: u32,
height_inc: u32
) -> WindowBuilder
Build window with resize increment hint. Only implemented on X11.
fn with_base_size(self, base_width: u32, base_height: u32) -> WindowBuilder
[src]
Build window with base size hint. Only implemented on X11.
impl Clone for 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]
Performs copy-assignment from source
. Read more