Struct sfml::window::VideoMode

pub struct VideoMode {
    pub width: u32,
    pub height: u32,
    pub bits_per_pixel: u32,
}

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

impl VideoMode

#[must_use]pub const fn new(width: u32, height: u32, bits_per_pixel: u32) -> Self

Constructs a new VideoMode from the given parameters.

#[must_use]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

#[must_use]pub fn desktop_mode() -> Self

Static Method, get the current desktop video mode

return the urrent desktop video mode

#[must_use]pub fn fullscreen_modes() -> Vec<Self>

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 VideoModes

Trait Implementations

impl Clone for VideoMode

fn clone(&self) -> VideoMode

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for VideoMode

impl Debug for VideoMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VideoMode

fn default() -> Self

Returns the “default value” for a type.

impl Eq for VideoMode

impl From<(u32, u32)> for VideoMode

fn from(src: (u32, u32)) -> Self

Constructs a VideoMode from (w, h). Bit depth is 32.

impl Ord for VideoMode

fn cmp(&self, other: &VideoMode) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<VideoMode> for VideoMode

fn eq(&self, other: &VideoMode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &VideoMode) -> bool

This method tests for !=.

impl PartialOrd<VideoMode> for VideoMode

fn partial_cmp(&self, other: &VideoMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for VideoMode

impl StructuralPartialEq for VideoMode