Struct SDL_WindowFlags 

#[repr(transparent)]
pub struct SDL_WindowFlags(pub Uint64);

The flags on a window.

These cover a lot of true/false, or on/off, window state. Some of it is immutable after being set through SDL_CreateWindow(), some of it can be changed on existing windows by the app, and some of it might be altered by the user or system outside of the app’s control.

When creating windows with SDL_WINDOW_RESIZABLE, SDL will constrain resizable windows to the dimensions recommended by the compositor to fit it within the usable desktop space, although some compositors will do this automatically without intervention as well. Use SDL_SetWindowResizable after creation instead if you wish to create a window with a specific size.

Availability

This datatype is available since SDL 3.2.0.

See also

• SDL_GetWindowFlags

Known values (sdl3-sys)

Associated constant	Global constant	Description
FULLSCREEN	SDL_WINDOW_FULLSCREEN	window is in fullscreen mode
OPENGL	SDL_WINDOW_OPENGL	window usable with OpenGL context
OCCLUDED	SDL_WINDOW_OCCLUDED	window is occluded
HIDDEN	SDL_WINDOW_HIDDEN	window is neither mapped onto the desktop nor shown in the taskbar/dock/window list; SDL_ShowWindow() is required for it to become visible
BORDERLESS	SDL_WINDOW_BORDERLESS	no window decoration
RESIZABLE	SDL_WINDOW_RESIZABLE	window can be resized
MINIMIZED	SDL_WINDOW_MINIMIZED	window is minimized
MAXIMIZED	SDL_WINDOW_MAXIMIZED	window is maximized
MOUSE_GRABBED	SDL_WINDOW_MOUSE_GRABBED	window has grabbed mouse input
INPUT_FOCUS	SDL_WINDOW_INPUT_FOCUS	window has input focus
MOUSE_FOCUS	SDL_WINDOW_MOUSE_FOCUS	window has mouse focus
EXTERNAL	SDL_WINDOW_EXTERNAL	window not created by SDL
MODAL	SDL_WINDOW_MODAL	window is modal
HIGH_PIXEL_DENSITY	SDL_WINDOW_HIGH_PIXEL_DENSITY	window uses high pixel density back buffer if possible
MOUSE_CAPTURE	SDL_WINDOW_MOUSE_CAPTURE	window has mouse captured (unrelated to MOUSE_GRABBED)
MOUSE_RELATIVE_MODE	SDL_WINDOW_MOUSE_RELATIVE_MODE	window has relative mode enabled
ALWAYS_ON_TOP	SDL_WINDOW_ALWAYS_ON_TOP	window should always be above others
UTILITY	SDL_WINDOW_UTILITY	window should be treated as a utility window, not showing in the task bar and window list
TOOLTIP	SDL_WINDOW_TOOLTIP	window should be treated as a tooltip and does not get mouse or keyboard focus, requires a parent window
POPUP_MENU	SDL_WINDOW_POPUP_MENU	window should be treated as a popup menu, requires a parent window
KEYBOARD_GRABBED	SDL_WINDOW_KEYBOARD_GRABBED	window has grabbed keyboard input
FILL_DOCUMENT	SDL_WINDOW_FILL_DOCUMENT	window is in fill-document mode (Emscripten only), since SDL 3.4.0
VULKAN	SDL_WINDOW_VULKAN	window usable for Vulkan surface
METAL	SDL_WINDOW_METAL	window usable for Metal view
TRANSPARENT	SDL_WINDOW_TRANSPARENT	window with transparent buffer
NOT_FOCUSABLE	SDL_WINDOW_NOT_FOCUSABLE	window should not be focusable

Tuple Fields

0: Uint64

Implementations

impl SDL_WindowFlags

pub const FULLSCREEN: Self

window is in fullscreen mode

pub const OPENGL: Self

window usable with OpenGL context

pub const OCCLUDED: Self

window is occluded

pub const HIDDEN: Self

window is neither mapped onto the desktop nor shown in the taskbar/dock/window list; SDL_ShowWindow() is required for it to become visible

pub const BORDERLESS: Self

no window decoration

pub const RESIZABLE: Self

window can be resized

pub const MINIMIZED: Self

window is minimized

pub const MAXIMIZED: Self

window is maximized

pub const MOUSE_GRABBED: Self

window has grabbed mouse input

pub const INPUT_FOCUS: Self

window has input focus

pub const MOUSE_FOCUS: Self

window has mouse focus

pub const EXTERNAL: Self

window not created by SDL

pub const MODAL: Self

window is modal

pub const HIGH_PIXEL_DENSITY: Self

window uses high pixel density back buffer if possible

pub const MOUSE_CAPTURE: Self

window has mouse captured (unrelated to MOUSE_GRABBED)

pub const MOUSE_RELATIVE_MODE: Self

window has relative mode enabled

pub const ALWAYS_ON_TOP: Self

window should always be above others

pub const UTILITY: Self

window should be treated as a utility window, not showing in the task bar and window list

pub const TOOLTIP: Self

window should be treated as a tooltip and does not get mouse or keyboard focus, requires a parent window

pub const POPUP_MENU: Self

window should be treated as a popup menu, requires a parent window

pub const KEYBOARD_GRABBED: Self

window has grabbed keyboard input

pub const FILL_DOCUMENT: Self

window is in fill-document mode (Emscripten only), since SDL 3.4.0

pub const VULKAN: Self

window usable for Vulkan surface

pub const METAL: Self

window usable for Metal view

pub const TRANSPARENT: Self

window with transparent buffer

pub const NOT_FOCUSABLE: Self

window should not be focusable

Trait Implementations

impl BitAnd for SDL_WindowFlags

type Output = SDL_WindowFlags

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for SDL_WindowFlags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for SDL_WindowFlags

type Output = SDL_WindowFlags

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for SDL_WindowFlags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for SDL_WindowFlags

type Output = SDL_WindowFlags

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for SDL_WindowFlags

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for SDL_WindowFlags

fn clone(&self) -> SDL_WindowFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_WindowFlags

Available on crate feature debug-impls only.

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

Formats the value using the given formatter.

impl Default for SDL_WindowFlags

fn default() -> SDL_WindowFlags

Returns the “default value” for a type.

impl From<SDL_WindowFlags> for Uint64

fn from(value: SDL_WindowFlags) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_WindowFlags

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_WindowFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Not for SDL_WindowFlags

type Output = SDL_WindowFlags

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<SDL_WindowFlags> for Uint64

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u64> for SDL_WindowFlags

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for SDL_WindowFlags

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SDL_WindowFlags

impl Eq for SDL_WindowFlags

impl StructuralPartialEq for SDL_WindowFlags