Expand description
VideoMode
defines a video mode (width, height, bpp)
A video mode is defined by a width and a height (in pixels) and a depth (in bits per pixel).
Video modes are used to setup windows at creation time.
The main usage of video modes is for fullscreen mode: indeed you must use one of the valid video modes allowed by the OS (which are defined by what the monitor and the graphics card support), otherwise your window creation will just fail.
VideoMode
provides an associated function for retrieving the list of all the video modes
supported by the system: VideoMode::fullscreen_modes
.
A custom video mode can also be checked directly for fullscreen compatibility
with its VideoMode::is_valid
function.
Additionally, VideoMode
provides a static function to get the mode currently used by
the desktop: VideoMode::desktop_mode
. This allows to build windows with the same size or
pixel depth as the current resolution.
Usage example
use sfml::window::{VideoMode, Window, Style};
// Display the list of all the video modes available for fullscreen
let modes = VideoMode::fullscreen_modes();
for mode in modes {
println!("{:?}", mode);
}
// Create a window with the same pixel depth as the desktop
let desktop = VideoMode::desktop_mode();
let _window = Window::new(VideoMode::new(1024, 768, desktop.bits_per_pixel),
"SFML window",
Style::CLOSE,
&Default::default());
Fields§
§width: u32
Video mode width, in pixels.
height: u32
Video mode height, in pixels.
bits_per_pixel: u32
Video mode pixel depth, in bits per pixels.
Implementations§
source§impl VideoMode
impl VideoMode
sourcepub const fn new(width: u32, height: u32, bits_per_pixel: u32) -> Self
pub const fn new(width: u32, height: u32, bits_per_pixel: u32) -> Self
Constructs a new VideoMode
from the given parameters.
sourcepub fn is_valid(&self) -> bool
pub fn is_valid(&self) -> bool
Tell whether or not a video mode is valid
The validity of video modes is only relevant when using fullscreen windows; otherwise any video mode can be used with no restriction.
return true if the video mode is valid for fullscreen mode
sourcepub fn desktop_mode() -> Self
pub fn desktop_mode() -> Self
Static Method, get the current desktop video mode
return the urrent desktop video mode
sourcepub fn fullscreen_modes() -> &'static sfVideoModeVector
pub fn fullscreen_modes() -> &'static sfVideoModeVector
Static Method, retrieve all the video modes supported in fullscreen mode
When creating a fullscreen window, the video mode is restricted
to be compatible with what the graphics driver and monitor
support. This function returns the complete list of all video
modes that can be used in fullscreen mode.
The returned array is sorted from best to worst, so that
the first element will always give the best mode (higher
width
, height
and bits_per_pixel
).
Return a vector containing all the supported VideoMode
s
Trait Implementations§
source§impl Ord for VideoMode
impl Ord for VideoMode
source§impl PartialEq<VideoMode> for VideoMode
impl PartialEq<VideoMode> for VideoMode
source§impl PartialOrd<VideoMode> for VideoMode
impl PartialOrd<VideoMode> for VideoMode
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more