Struct piston::WindowSettings [−][src]
pub struct WindowSettings { /* fields omitted */ }
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
Creates window settings with defaults.
- samples: 0
- fullscreen: false
exit_on_esc
: false- vsync: false
- srgb: true
- resizable: true
- decorated: true
- controllers: true
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.
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.
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.
Gets whether built windows will be fullscreen.
Sets whether built windows will be fullscreen.
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.
Gets whether built windows should exit when the Esc key is pressed.
Sets whether built windows should exit when the Esc key is pressed.
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.
Gets whether built windows should automatically close when the X or ALT+F4 are pressed.
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.
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.
Gets the number of samples to use for anti-aliasing.
See https://en.wikipedia.org/wiki/Multisample_anti-aliasing for more information.
Sets the number of samples to use for anti-aliasing.
See https://en.wikipedia.org/wiki/Multisample_anti-aliasing for more information.
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.
Gets whether built windows should use vsync.
See https://en.wikipedia.org/wiki/Screen_tearing for more information> about vsync.
Sets whether built windows should use vsync.
See https://en.wikipedia.org/wiki/Screen_tearing for more information> about vsync.
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.
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.
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.
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.
Sets graphics API version of built windows.
For setting the graphics API version back to default, see
set_maybe_graphics_api()
.
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.
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.
Sets whether built windows should use hardware accelerated color conversion.
See get_srgb()
for more information about
the srgb setting.
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.
Gets whether built windows should be resizable.
Sets whether built windows should be resizable.
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.
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
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
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.
Gets whether built windows should listen to controller input.
Sets whether built windows should listen to controller input.
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.
Gets whether built windows should be transparent.
Sets whether built windows should be transparent.
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
Auto Trait Implementations
impl RefUnwindSafe for WindowSettings
impl Send for WindowSettings
impl Sync for WindowSettings
impl Unpin for WindowSettings
impl UnwindSafe for WindowSettings
Blanket Implementations
Mutably borrows from an owned value. Read more