rolmodl
C++ API for the Simple Directmedia Library 2 (SDL2)
Public Member Functions | List of all members
rolmodl::win::Flags Struct Reference

Window configuration (flags) container. More...

#include <Win.hpp>

Public Member Functions

constexpr Flags () noexcept
 Create a configuration corresponding to a default window.
 
constexpr bool isFullscreen () const noexcept
 Test whether this configuration corresponds to a fullscreen window. The SDL flag equivalent is SDL_WINDOW_FULLSCREEN.
 
constexpr bool isFullscreenDesktop () const noexcept
 Test whether this configuration corresponds to a desktop-resolution fullscreen window. The SDL flag equivalent is SDL_WINDOW_FULLSCREEN_DESKTOP.
 
constexpr bool isMinimized () const noexcept
 Test whether this configuration corresponds to a minimized window. The SDL flag equivalent is SDL_WINDOW_MINIMIZED.
 
constexpr bool isMaximized () const noexcept
 Test whether this configuration corresponds to a maximized window. The SDL flag equivalent is SDL_WINDOW_MAXIMIZED.
 
constexpr bool isOpengl () const noexcept
 Test whether this configuration corresponds to a window usable with OpenGL. The SDL flag equivalent is SDL_WINDOW_OPENGL. More...
 
constexpr bool isHidden () const noexcept
 Test whether this configuration corresponds to a hidden window. The SDL flag equivalent is SDL_WINDOW_HIDDEN.
 
constexpr bool isBorderless () const noexcept
 Test whether this configuration corresponds to a borderless window. The SDL flag equivalent is SDL_WINDOW_BORDERLESS.
 
constexpr bool isResizable () const noexcept
 Test whether this configuration corresponds to a resizable window. The SDL flag equivalent is SDL_WINDOW_RESIZABLE.
 
constexpr bool isInputGrabbed () const noexcept
 Test whether this configuration corresponds to a window that has grabbed input focus. The SDL flag equivalent is SDL_WINDOW_INPUT_GRABBED.
 
constexpr bool isHighDPI () const noexcept
 Test whether this configuration corresponds to a window with preference for high DPI display. The SDL flag equivalent is SDL_WINDOW_ALLOW_HIGHDPI.
 
constexpr Flags withFullscreen () const noexcept
 Create a version of this configuration that corresponds to a fullscreen window. The SDL flag equivalent is SDL_WINDOW_FULLSCREEN.
 
constexpr Flags withFullscreenDesktop () const noexcept
 Create a version of this configuration that corresponds to a desktop-resolution fullscreen window. The SDL flag equivalent is SDL_WINDOW_FULLSCREEN_DESKTOP.
 
constexpr Flags withMinimized () const noexcept
 Create a version of this configuration that corresponds to a minimized window. The SDL flag equivalent is SDL_WINDOW_MINIMIZED.
 
constexpr Flags withMaximized () const noexcept
 Create a version of this configuration that corresponds to a maximized window. The SDL flag equivalent is SDL_WINDOW_MAXIMIZED.
 
constexpr Flags withOpengl () const noexcept
 Create a version of this configuration that corresponds to a window usable with OpenGL. The SDL flag equivalent is SDL_WINDOW_OPENGL. More...
 
constexpr Flags withHidden () const noexcept
 Create a version of this configuration that corresponds to a hidden window. The SDL flag equivalent is SDL_WINDOW_HIDDEN.
 
constexpr Flags withBorderless () const noexcept
 Create a version of this configuration that corresponds to a borderless window. The SDL flag equivalent is SDL_WINDOW_BORDERLESS.
 
constexpr Flags withResizable () const noexcept
 Create a version of this configuration that corresponds to a resizable window. The SDL flag equivalent is SDL_WINDOW_RESIZABLE.
 
constexpr Flags withInputGrabbed () const noexcept
 Create a version of this configuration that corresponds to a window that has grabbed input focus. The SDL flag equivalent is SDL_WINDOW_INPUT_GRABBED.
 
constexpr Flags withHighDPI () const noexcept
 Create a version of this configuration that corresponds to a window with preference for high DPI display. The SDL flag equivalent is SDL_WINDOW_ALLOW_HIGHDPI.
 
constexpr Flags withoutFullscreen () const noexcept
 Create a version of this configuration that corresponds to a window that is not fullscreen. The SDL flag equivalent is ~SDL_WINDOW_FULLSCREEN.
 
constexpr Flags withoutFullscreenDesktop () const noexcept
 Create a version of this configuration that corresponds to a window that is not display-resolution fullscreen. The SDL flag equivalent is ~SDL_WINDOW_FULLSCREEN_DESKTOP.
 
constexpr Flags withoutMinimized () const noexcept
 Create a version of this configuration that corresponds to a window that is not minimized. The SDL flag equivalent is ~SDL_WINDOW_MINIMIZED.
 
constexpr Flags withoutMaximized () const noexcept
 Create a version of this configuration that corresponds to a window that is not maximized. The SDL flag equivalent is ~SDL_WINDOW_MAXIMIZED.
 
constexpr Flags withoutOpengl () const noexcept
 Create a version of this configuration that corresponds to a window that is not usable with OpenGL. The SDL flag equivalent is ~SDL_WINDOW_OPENGL.
 
constexpr Flags withoutHidden () const noexcept
 Create a version of this configuration that corresponds to a window that is not hidden. The SDL flag equivalent is ~SDL_WINDOW_HIDDEN.
 
constexpr Flags withoutBorderless () const noexcept
 Create a version of this configuration that corresponds to a window that is not borderless. The SDL flag equivalent is ~SDL_WINDOW_BORDERLESS.
 
constexpr Flags withoutResizable () const noexcept
 Create a version of this configuration that corresponds to a window that is not resizable. The SDL flag equivalent is ~SDL_WINDOW_RESIZABLE.
 
constexpr Flags withoutInputGrabbed () const noexcept
 Create a version of this configuration that corresponds to a window that has not grabbed input focus. The SDL flag equivalent is ~SDL_WINDOW_INPUT_GRABBED.
 
constexpr Flags withoutHighDPI () const noexcept
 Create a version of this configuration that corresponds to a window with no preference for high DPI display. The SDL flag equivalent is ~SDL_WINDOW_ALLOW_HIGHDPI.
 
constexpr uint32_t raw () const noexcept
 Return the underlying bitfield representation of this configuration.
 

Detailed Description

Window configuration (flags) container.

Todo:
fixme: no support for some window flags i dont understand todo: some flags are mutually exclusive
See also
https://wiki.libsdl.org/SDL_WindowFlags

Definition at line 25 of file Win.hpp.

Member Function Documentation

◆ isOpengl()

constexpr bool rolmodl::win::Flags::isOpengl ( ) const
inlineconstexprnoexcept

Test whether this configuration corresponds to a window usable with OpenGL. The SDL flag equivalent is SDL_WINDOW_OPENGL.

Todo:
add a "see also" on something about OpenGL.

Definition at line 53 of file Win.hpp.

◆ withOpengl()

constexpr Flags rolmodl::win::Flags::withOpengl ( ) const
inlineconstexprnoexcept

Create a version of this configuration that corresponds to a window usable with OpenGL. The SDL flag equivalent is SDL_WINDOW_OPENGL.

Todo:
add a "see also" on something about OpenGL.

Definition at line 98 of file Win.hpp.

References Flags().

The documentation for this struct was generated from the following file:
Generated by   doxygen 1.8.16