SFML - Simple and Fast Multimedia Library

SFML 3.1.0
Loading...
Searching...
No Matches
VideoMode.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2026 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#pragma once
26
28// Headers
30#include <SFML/Window/Export.hpp>
31
32#include <SFML/System/Vector2.hpp>
33
34#include <vector>
35
36
37namespace sf
38{
43 class SFML_WINDOW_API VideoMode
44{
45public:
52 VideoMode() = default;
53
61 explicit VideoMode(Vector2u modeSize, unsigned int modeBitsPerPixel = 32);
62
69 [[nodiscard]] static VideoMode getDesktopMode();
70
85 [[nodiscard]] static const std::vector<VideoMode>& getFullscreenModes();
86
97 [[nodiscard]] bool isValid() const;
98
100 // Member data
102 Vector2u size;
103 unsigned int bitsPerPixel{};
104};
105
116[[nodiscard]] SFML_WINDOW_API bool operator==(const VideoMode& left, const VideoMode& right);
117
128[[nodiscard]] SFML_WINDOW_API bool operator!=(const VideoMode& left, const VideoMode& right);
129
140[[nodiscard]] SFML_WINDOW_API bool operator<(const VideoMode& left, const VideoMode& right);
141
152[[nodiscard]] SFML_WINDOW_API bool operator>(const VideoMode& left, const VideoMode& right);
153
164[[nodiscard]] SFML_WINDOW_API bool operator<=(const VideoMode& left, const VideoMode& right);
165
176[[nodiscard]] SFML_WINDOW_API bool operator>=(const VideoMode& left, const VideoMode& right);
177
178} // namespace sf
179
180
Vector2.hpp
Export.hpp
SFML_WINDOW_API
#define SFML_WINDOW_API
Definition Window/Export.hpp:42
sf::VideoMode::getFullscreenModes
static const std::vector< VideoMode > & getFullscreenModes()
Retrieve all the video modes supported in fullscreen mode.
sf::VideoMode::operator!=
bool operator!=(const VideoMode &left, const VideoMode &right)
Overload of operator!= to compare two video modes.
sf::VideoMode::operator<
bool operator<(const VideoMode &left, const VideoMode &right)
Overload of operator< to compare video modes.
sf::VideoMode::operator>
bool operator>(const VideoMode &left, const VideoMode &right)
Overload of operator> to compare video modes.
sf::VideoMode::VideoMode
VideoMode()=default
Default constructor.
sf::VideoMode::operator>=
bool operator>=(const VideoMode &left, const VideoMode &right)
Overload of operator>= to compare video modes.
sf::VideoMode::VideoMode
VideoMode(Vector2u modeSize, unsigned int modeBitsPerPixel=32)
Construct the video mode with its attributes.
sf::VideoMode::bitsPerPixel
unsigned int bitsPerPixel
Video mode pixel depth, in bits per pixels.
Definition VideoMode.hpp:103
sf::VideoMode::operator<=
bool operator<=(const VideoMode &left, const VideoMode &right)
Overload of operator<= to compare video modes.
sf::VideoMode::getDesktopMode
static VideoMode getDesktopMode()
Get the current desktop video mode.
sf::VideoMode::operator==
bool operator==(const VideoMode &left, const VideoMode &right)
Overload of operator== to compare two video modes.
sf::VideoMode::isValid
bool isValid() const
Tell whether or not the video mode is valid.
sf::VideoMode::size
Vector2u size
Video mode width and height, in pixels.
Definition VideoMode.hpp:102
sf
Definition AudioResource.hpp:36
sf::Vector2u
Vector2< unsigned int > Vector2u
Definition Vector2.hpp:212