Struct piston::WindowSettings
source · pub struct WindowSettings { /* private fields */ }
Expand description
Settings structure for window behavior.
This structure stores everything that needs to be customized when constructing most windows. This structure makes it easy to create multiple windows with the same settings, and it also makes piston’s multiple backends easier to implement for piston devs.
Implementations§
source§impl WindowSettings
impl WindowSettings
sourcepub fn new<T, S>(title: T, size: S) -> WindowSettings
pub fn new<T, S>(title: T, size: S) -> WindowSettings
Creates window settings with defaults.
- samples: 0
- fullscreen: false
- exit_on_esc: false
- automatic_close: true
- vsync: false
- graphics_api: None
- srgb: true
- resizable: true
- decorated: true
- controllers: true
- transparent: false
sourcepub fn build<W>(&self) -> Result<W, Box<dyn Error>>where
W: BuildFromWindowSettings,
pub fn build<W>(&self) -> Result<W, Box<dyn Error>>where
W: BuildFromWindowSettings,
Builds window from the given settings.
The return value is ambiguous, to allow for operation on multiple backends. Clients should explicitly name the return type. See the Guide to using Piston Windows for more info and examples.
§Errors
This function will return an error if your backend returns an error.
See your backend’s documentation on build_from_window_settings()
for more details.
sourcepub fn title(self, value: String) -> WindowSettings
pub fn title(self, value: String) -> WindowSettings
Sets the title of built windows.
This method moves the current window data,
unlike set_title()
,
so that it can be used in method chaining.
sourcepub fn size(self, value: Size) -> WindowSettings
pub fn size(self, value: Size) -> WindowSettings
Sets the size of built windows.
This method moves the current window data,
unlike set_size()
,
so that it can be used in method chaining.
sourcepub fn get_fullscreen(&self) -> bool
pub fn get_fullscreen(&self) -> bool
Gets whether built windows will be fullscreen.
sourcepub fn set_fullscreen(&mut self, value: bool)
pub fn set_fullscreen(&mut self, value: bool)
Sets whether built windows will be fullscreen.
sourcepub fn fullscreen(self, value: bool) -> WindowSettings
pub fn fullscreen(self, value: bool) -> WindowSettings
Sets whether built windows will be fullscreen.
This method moves the current window data,
unlike set_fullscreen()
,
so that it can be used in method chaining.
sourcepub fn get_exit_on_esc(&self) -> bool
pub fn get_exit_on_esc(&self) -> bool
Gets whether built windows should exit when the Esc key is pressed.
sourcepub fn set_exit_on_esc(&mut self, value: bool)
pub fn set_exit_on_esc(&mut self, value: bool)
Sets whether built windows should exit when the Esc key is pressed.
sourcepub fn exit_on_esc(self, value: bool) -> WindowSettings
pub fn exit_on_esc(self, value: bool) -> WindowSettings
Sets whether built windows should exit when the Esc key is pressed.
This method moves the current window data,
unlike set_exit_on_esc()
,
so that it can be used in method chaining.
sourcepub fn get_automatic_close(&self) -> bool
pub fn get_automatic_close(&self) -> bool
Gets whether built windows should automatically close when the X or ALT+F4 are pressed.
sourcepub fn set_automatic_close(&mut self, value: bool)
pub fn set_automatic_close(&mut self, value: bool)
Sets whether built windows should automatically close when the X or
ALT+F4 are pressed. If this is disabled, attempts to close the window
can be detected via an Input::Close(..)
event, and
Window::set_should_close()
can be called to actually close the window.
sourcepub fn automatic_close(self, value: bool) -> WindowSettings
pub fn automatic_close(self, value: bool) -> WindowSettings
Sets whether built windows should automatically close when the X or
ALT+F4 are pressed. If this is disabled, attempts to close the window
can be detected via an Input::Close(..)
event, and
Window::set_should_close()
can be called to actually close the window.
This method moves the current window data,
unlike set_automatic_close()
,
so that it can be used in method chaining.
sourcepub fn get_samples(&self) -> u8
pub fn get_samples(&self) -> u8
Gets the number of samples to use for anti-aliasing.
See https://en.wikipedia.org/wiki/Multisample_anti-aliasing for more information.
sourcepub fn set_samples(&mut self, value: u8)
pub fn set_samples(&mut self, value: u8)
Sets the number of samples to use for anti-aliasing.
See https://en.wikipedia.org/wiki/Multisample_anti-aliasing for more information.
sourcepub fn samples(self, value: u8) -> WindowSettings
pub fn samples(self, value: u8) -> WindowSettings
Sets the number of samples to use for anti-aliasing.
See https://en.wikipedia.org/wiki/Multisample_anti-aliasing for more information.
This method moves the current window data,
unlike set_samples()
so that it can be used in method chaining.
sourcepub fn get_vsync(&self) -> bool
pub fn get_vsync(&self) -> bool
Gets whether built windows should use vsync.
See https://en.wikipedia.org/wiki/Screen_tearing for more information> about vsync.
sourcepub fn set_vsync(&mut self, value: bool)
pub fn set_vsync(&mut self, value: bool)
Sets whether built windows should use vsync.
See https://en.wikipedia.org/wiki/Screen_tearing for more information> about vsync.
sourcepub fn vsync(self, value: bool) -> WindowSettings
pub fn vsync(self, value: bool) -> WindowSettings
Sets whether built windows should use vsync.
See https://en.wikipedia.org/wiki/Screen_tearing for more information> about vsync.
This method moves the current window data,
unlike set_vsync()
,
so that it can be used in method chaining.
sourcepub fn get_maybe_graphics_api(&self) -> Option<Version>
pub fn get_maybe_graphics_api(&self) -> Option<Version>
Gets the graphics API version of built windows.
If None is returned, the default graphics API version is being used. This is often a forward compatible version of OpenGL 3.2 or higher that works with newer versions of graphics libraries.
sourcepub fn set_maybe_graphics_api<V>(&mut self, value: Option<V>)
pub fn set_maybe_graphics_api<V>(&mut self, value: Option<V>)
Sets graphics API version of built windows.
If None is passed, the default graphics API version is used. This is often a forward compatible version of OpenGL 3.2 or higher that works with newer versions of graphics libraries.
sourcepub fn maybe_graphics_api<V>(self, value: Option<V>) -> WindowSettings
pub fn maybe_graphics_api<V>(self, value: Option<V>) -> WindowSettings
Sets graphics API version of built windows.
If None is passed, the default graphics API version is used. This is often a forward compatible version of OpenGL 3.2 or higher that works with newer versions of graphics libraries.
This method moves the current window data,
unlike set_maybe_graphics_api()
,
so that it can be used in method chaining.
sourcepub fn set_graphics_api<V>(&mut self, value: V)
pub fn set_graphics_api<V>(&mut self, value: V)
Sets graphics API version of built windows.
For setting the graphics API version back to default, see
set_maybe_graphics_api()
.
sourcepub fn graphics_api<V>(self, value: V) -> WindowSettings
pub fn graphics_api<V>(self, value: V) -> WindowSettings
Sets the graphics API version of built windows.
For setting the graphics API version back to default, see
maybe_graphics_api()
.
This method moves the current window data,
unlike set_graphics_api()
,
so that it can be used in method chaining.
sourcepub fn get_srgb(&self) -> bool
pub fn get_srgb(&self) -> bool
Gets whether built windows should use hardware accelerated color conversion.
If true, the graphics hardware uses customized circuitry
to convert colors from sRGB
to linear color space in graphics
shaders, and then converts pixel fragments back to sRGB
depending on the color format of the frame buffer. This feature
is supported by most graphics hardware and set to true by
default.
See https://en.wikipedia.org/wiki/SRGB for more information.
sourcepub fn set_srgb(&mut self, value: bool)
pub fn set_srgb(&mut self, value: bool)
Sets whether built windows should use hardware accelerated color conversion.
See get_srgb()
for more information about
the srgb setting.
sourcepub fn srgb(self, value: bool) -> WindowSettings
pub fn srgb(self, value: bool) -> WindowSettings
Sets whether built windows should use hardware accelerated color conversion.
See get_srgb()
for more information about
the srgb setting.
This method moves the current window data,
unlike set_srgb()
,
so that it can be used in method chaining.
sourcepub fn get_resizable(&self) -> bool
pub fn get_resizable(&self) -> bool
Gets whether built windows should be resizable.
sourcepub fn set_resizable(&mut self, value: bool)
pub fn set_resizable(&mut self, value: bool)
Sets whether built windows should be resizable.
sourcepub fn resizable(self, value: bool) -> WindowSettings
pub fn resizable(self, value: bool) -> WindowSettings
Sets whether built windows should be resizable.
This method moves the current window data,
unlike set_resizable()
,
so that it can be used in method chaining.
sourcepub fn get_decorated(&self) -> bool
pub fn get_decorated(&self) -> bool
Gets whether built windows should be decorated.
Decoration on a window refers to the Operating System’s header above the window, and the window border.
For more information, see https://en.wikipedia.org/wiki/Window_decoration
sourcepub fn set_decorated(&mut self, value: bool)
pub fn set_decorated(&mut self, value: bool)
Sets whether built windows should be decorated.
Decoration on a window refers to the Operating System’s header above the window, and the window border.
For more information, see https://en.wikipedia.org/wiki/Window_decoration
sourcepub fn decorated(self, value: bool) -> WindowSettings
pub fn decorated(self, value: bool) -> WindowSettings
Sets whether built windows should be decorated.
Decoration on a window refers to the Operating System’s header above the window, and the window border.
For more information, see https://en.wikipedia.org/wiki/Window_decoration
This method moves the current window data,
unlike set_decorated()
,
so that it can be used in method chaining.
sourcepub fn get_controllers(&self) -> bool
pub fn get_controllers(&self) -> bool
Gets whether built windows should listen to controller input.
sourcepub fn set_controllers(&mut self, value: bool)
pub fn set_controllers(&mut self, value: bool)
Sets whether built windows should listen to controller input.
sourcepub fn controllers(self, value: bool) -> WindowSettings
pub fn controllers(self, value: bool) -> WindowSettings
Sets whether built windows should listen to controller input.
This method moves the current window data,
unlike set_controllers()
,
so that it can be used in method chaining.
sourcepub fn get_transparent(&self) -> bool
pub fn get_transparent(&self) -> bool
Gets whether built windows should be transparent.
sourcepub fn set_transparent(&mut self, value: bool)
pub fn set_transparent(&mut self, value: bool)
Sets whether built windows should be transparent.
sourcepub fn transparent(self, value: bool) -> WindowSettings
pub fn transparent(self, value: bool) -> WindowSettings
Sets whether built windows should be transparent.
This method moves the current window data,
unlike set_transparent()
,
so that it can be used in method chaining.
Trait Implementations§
source§impl Clone for WindowSettings
impl Clone for WindowSettings
source§fn clone(&self) -> WindowSettings
fn clone(&self) -> WindowSettings
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more