Struct cosmic::iced_winit::winit::window::WindowAttributes
source · pub struct WindowAttributes {Show 20 fields
pub surface_size: Option<Size>,
pub min_surface_size: Option<Size>,
pub max_surface_size: Option<Size>,
pub surface_resize_increments: Option<Size>,
pub position: Option<Position>,
pub resizable: bool,
pub enabled_buttons: WindowButtons,
pub title: String,
pub maximized: bool,
pub visible: bool,
pub transparent: bool,
pub blur: bool,
pub decorations: bool,
pub window_icon: Option<Icon>,
pub preferred_theme: Option<Theme>,
pub content_protected: bool,
pub window_level: WindowLevel,
pub active: bool,
pub cursor: Cursor,
pub fullscreen: Option<Fullscreen>,
/* private fields */
}
Expand description
Attributes used when creating a window.
Fields§
§surface_size: Option<Size>
§min_surface_size: Option<Size>
§max_surface_size: Option<Size>
§surface_resize_increments: Option<Size>
§position: Option<Position>
§resizable: bool
§title: String
§maximized: bool
§visible: bool
§transparent: bool
§blur: bool
§decorations: bool
§window_icon: Option<Icon>
§preferred_theme: Option<Theme>
§content_protected: bool
§window_level: WindowLevel
§active: bool
§cursor: Cursor
§fullscreen: Option<Fullscreen>
Implementations§
source§impl WindowAttributes
impl WindowAttributes
sourcepub fn parent_window(&self) -> Option<&RawWindowHandle>
pub fn parent_window(&self) -> Option<&RawWindowHandle>
Get the parent window stored on the attributes.
sourcepub fn with_surface_size<S>(self, size: S) -> WindowAttributes
pub fn with_surface_size<S>(self, size: S) -> WindowAttributes
Requests the surface to be of specific dimensions.
If this is not set, some platform-specific dimensions will be used.
See Window::request_surface_size
for details.
sourcepub fn with_min_surface_size<S>(self, min_size: S) -> WindowAttributes
pub fn with_min_surface_size<S>(self, min_size: S) -> WindowAttributes
Sets the minimum dimensions the surface can have.
If this is not set, the surface will have no minimum dimensions (aside from reserved).
See Window::set_min_surface_size
for details.
sourcepub fn with_max_surface_size<S>(self, max_size: S) -> WindowAttributes
pub fn with_max_surface_size<S>(self, max_size: S) -> WindowAttributes
Sets the maximum dimensions the surface can have.
If this is not set, the surface will have no maximum, or the maximum will be restricted to the primary monitor’s dimensions by the platform.
See Window::set_max_surface_size
for details.
sourcepub fn with_surface_resize_increments<S>(
self,
surface_resize_increments: S,
) -> WindowAttributes
pub fn with_surface_resize_increments<S>( self, surface_resize_increments: S, ) -> WindowAttributes
Build window with resize increments hint.
The default is None
.
See Window::set_surface_resize_increments
for details.
sourcepub fn with_position<P>(self, position: P) -> WindowAttributes
pub fn with_position<P>(self, position: P) -> WindowAttributes
Sets a desired initial position for the window.
If this is not set, some platform-specific position will be chosen.
See Window::set_outer_position
for details.
§Platform-specific
- macOS: The top left corner position of the window content, the window’s “inner”
position. The window title bar will be placed above it. The window will be positioned such
that it fits on screen, maintaining set
surface_size
if any. If you need to precisely position the top left corner of the whole window you have to useWindow::set_outer_position
after creating the window. - Windows: The top left corner position of the window title bar, the window’s “outer” position. There may be a small gap between this position and the window due to the specifics of the Window Manager.
- X11: The top left corner of the window, the window’s “outer” position.
- Others: Ignored.
sourcepub fn with_resizable(self, resizable: bool) -> WindowAttributes
pub fn with_resizable(self, resizable: bool) -> WindowAttributes
Sets whether the window is resizable or not.
The default is true
.
See Window::set_resizable
for details.
Sets the enabled window buttons.
The default is WindowButtons::all
See Window::set_enabled_buttons
for details.
sourcepub fn with_title<T>(self, title: T) -> WindowAttributes
pub fn with_title<T>(self, title: T) -> WindowAttributes
Sets the initial title of the window in the title bar.
The default is "winit window"
.
See Window::set_title
for details.
sourcepub fn with_fullscreen(self, fullscreen: Option<Fullscreen>) -> WindowAttributes
pub fn with_fullscreen(self, fullscreen: Option<Fullscreen>) -> WindowAttributes
Sets whether the window should be put into fullscreen upon creation.
The default is None
.
See Window::set_fullscreen
for details.
sourcepub fn with_maximized(self, maximized: bool) -> WindowAttributes
pub fn with_maximized(self, maximized: bool) -> WindowAttributes
Request that the window is maximized upon creation.
The default is false
.
See Window::set_maximized
for details.
sourcepub fn with_visible(self, visible: bool) -> WindowAttributes
pub fn with_visible(self, visible: bool) -> WindowAttributes
Sets whether the window will be initially visible or hidden.
The default is to show the window.
See Window::set_visible
for details.
sourcepub fn with_transparent(self, transparent: bool) -> WindowAttributes
pub fn with_transparent(self, transparent: bool) -> WindowAttributes
Sets whether the background of the window should be transparent.
If this is true
, writing colors with alpha values different than
1.0
will produce a transparent window. On some platforms this
is more of a hint for the system and you’d still have the alpha
buffer. To control it see Window::set_transparent
.
The default is false
.
sourcepub fn with_blur(self, blur: bool) -> WindowAttributes
pub fn with_blur(self, blur: bool) -> WindowAttributes
Sets whether the background of the window should be blurred by the system.
The default is false
.
See Window::set_blur
for details.
sourcepub fn transparent(&self) -> bool
pub fn transparent(&self) -> bool
Get whether the window will support transparency.
sourcepub fn with_decorations(self, decorations: bool) -> WindowAttributes
pub fn with_decorations(self, decorations: bool) -> WindowAttributes
Sets whether the window should have a border, a title bar, etc.
The default is true
.
See Window::set_decorations
for details.
sourcepub fn with_window_level(self, level: WindowLevel) -> WindowAttributes
pub fn with_window_level(self, level: WindowLevel) -> WindowAttributes
Sets the window level.
This is just a hint to the OS, and the system could ignore it.
The default is WindowLevel::Normal
.
See WindowLevel
for details.
sourcepub fn with_window_icon(self, window_icon: Option<Icon>) -> WindowAttributes
pub fn with_window_icon(self, window_icon: Option<Icon>) -> WindowAttributes
sourcepub fn with_theme(self, theme: Option<Theme>) -> WindowAttributes
pub fn with_theme(self, theme: Option<Theme>) -> WindowAttributes
Sets a specific theme for the window.
If None
is provided, the window will use the system theme.
The default is None
.
§Platform-specific
- Wayland: This controls only CSD. When using
None
it’ll try to use dbus to get the system preference. When explicit theme is used, this will avoid dbus all together. - x11: Build window with
_GTK_THEME_VARIANT
hint set todark
orlight
. - iOS / Android / Web / x11 / Orbital: Ignored.
sourcepub fn with_content_protected(self, protected: bool) -> WindowAttributes
pub fn with_content_protected(self, protected: bool) -> WindowAttributes
Prevents the window contents from being captured by other apps.
The default is false
.
§Platform-specific
- macOS: if
false
,NSWindowSharingNone
is used but doesn’t completely prevent all apps from reading the window content, for instance, QuickTime. - iOS / Android / Web / x11 / Orbital: Ignored.
sourcepub fn with_active(self, active: bool) -> WindowAttributes
pub fn with_active(self, active: bool) -> WindowAttributes
Whether the window will be initially focused or not.
The window should be assumed as not focused by default
following by the WindowEvent::Focused
.
§Platform-specific:
Android / iOS / X11 / Wayland / Orbital: Unsupported.
sourcepub fn with_cursor(self, cursor: impl Into<Cursor>) -> WindowAttributes
pub fn with_cursor(self, cursor: impl Into<Cursor>) -> WindowAttributes
Modifies the cursor icon of the window.
The default is CursorIcon::Default
.
See Window::set_cursor()
for more details.
sourcepub unsafe fn with_parent_window(
self,
parent_window: Option<RawWindowHandle>,
) -> WindowAttributes
pub unsafe fn with_parent_window( self, parent_window: Option<RawWindowHandle>, ) -> WindowAttributes
Build window with parent window.
The default is None
.
§Safety
parent_window
must be a valid window handle.
§Platform-specific
- Windows : A child window has the WS_CHILD style and is confined to the client area of its parent window. For more information, see https://docs.microsoft.com/en-us/windows/win32/winmsg/window-features#child-windows
- X11: A child window is confined to the client area of its parent window.
- Android / iOS / Wayland / Web: Unsupported.
Trait Implementations§
source§impl Clone for WindowAttributes
impl Clone for WindowAttributes
source§fn clone(&self) -> WindowAttributes
fn clone(&self) -> WindowAttributes
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WindowAttributes
impl Debug for WindowAttributes
source§impl Default for WindowAttributes
impl Default for WindowAttributes
source§fn default() -> WindowAttributes
fn default() -> WindowAttributes
source§impl PartialEq for WindowAttributes
impl PartialEq for WindowAttributes
source§impl WindowAttributesExtStartupNotify for WindowAttributes
impl WindowAttributesExtStartupNotify for WindowAttributes
source§fn with_activation_token(self, token: ActivationToken) -> WindowAttributes
fn with_activation_token(self, token: ActivationToken) -> WindowAttributes
ActivationToken
during window creation. Read moresource§impl WindowAttributesExtX11 for WindowAttributes
impl WindowAttributesExtX11 for WindowAttributes
source§fn with_x11_visual(self, visual_id: u32) -> WindowAttributes
fn with_x11_visual(self, visual_id: u32) -> WindowAttributes
fn with_x11_screen(self, screen_id: i32) -> WindowAttributes
source§fn with_name(
self,
general: impl Into<String>,
instance: impl Into<String>,
) -> WindowAttributes
fn with_name( self, general: impl Into<String>, instance: impl Into<String>, ) -> WindowAttributes
source§fn with_override_redirect(self, override_redirect: bool) -> WindowAttributes
fn with_override_redirect(self, override_redirect: bool) -> WindowAttributes
source§fn with_x11_window_type(
self,
x11_window_types: Vec<WindowType>,
) -> WindowAttributes
fn with_x11_window_type( self, x11_window_types: Vec<WindowType>, ) -> WindowAttributes
_NET_WM_WINDOW_TYPE
hints; defaults to Normal
.source§fn with_base_size<S>(self, base_size: S) -> WindowAttributes
fn with_base_size<S>(self, base_size: S) -> WindowAttributes
source§fn with_embed_parent_window(self, parent_window_id: u32) -> WindowAttributes
fn with_embed_parent_window(self, parent_window_id: u32) -> WindowAttributes
impl StructuralPartialEq for WindowAttributes
Auto Trait Implementations§
impl Freeze for WindowAttributes
impl !RefUnwindSafe for WindowAttributes
impl Send for WindowAttributes
impl Sync for WindowAttributes
impl Unpin for WindowAttributes
impl !UnwindSafe for WindowAttributes
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
impl<T, Res> Apply<Res> for Twhere
T: ?Sized,
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for Uwhere
T: FromCam16Unclamped<WpParam, U>,
source§type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn cam16_into_unclamped(
self,
parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>,
) -> T
fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for Uwhere
T: Cam16FromUnclamped<WpParam, U>,
source§type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar
parameters
when converting.source§fn into_cam16_unclamped(
self,
parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>,
) -> T
fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T
self
into C
, using the provided parameters.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
source§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more