Struct cushy::window::Window

pub struct Window<Behavior = WidgetInstance>
where
    Behavior: WindowBehavior,
{
    pub attributes: WindowAttributes,
    pub title: Value<String>,
    pub theme: Value<ThemePair>,
    pub load_system_fonts: bool,
    pub serif_font_family: FontFamilyList,
    pub sans_serif_font_family: FontFamilyList,
    pub fantasy_font_family: FontFamilyList,
    pub monospace_font_family: FontFamilyList,
    pub cursive_font_family: FontFamilyList,
    pub fonts: FontCollection,
    pub vsync: bool,
    pub multisample_count: NonZeroU32,
    /* private fields */
}

A Cushy window that is not yet running.

Fields

attributes: WindowAttributes

The attributes of this window.

title: Value<String>

The title to display in the title bar of the window.

theme: Value<ThemePair>

The colors to use to theme the user interface.

load_system_fonts: bool

When true, the system fonts will be loaded into the font database. This is on by default.

serif_font_family: FontFamilyList

The list of font families to try to find when a FamilyOwned::Serif font is requested.

sans_serif_font_family: FontFamilyList

The list of font families to try to find when a FamilyOwned::SansSerif font is requested.

fantasy_font_family: FontFamilyList

The list of font families to try to find when a FamilyOwned::Fantasy font is requested.

monospace_font_family: FontFamilyList

The list of font families to try to find when a FamilyOwned::Monospace font is requested.

cursive_font_family: FontFamilyList

The list of font families to try to find when a FamilyOwned::Cursive font is requested.

fonts: FontCollection

A collection of fonts that this window will load.

vsync: bool

When true, Cushy will try to use “vertical sync” to try to eliminate graphical tearing that can occur if the graphics card has a new frame presented while the monitor is currently rendering another frame.

Under the hood, Cushy uses wgpu::PresentMode::AutoVsync when true and wgpu::PresentMode::AutoNoVsync when false.

multisample_count: NonZeroU32

The number of samples to perform for each pixel rendered to the screen. When 1, multisampling is disabled.

Implementations

impl Window<WidgetInstance>

pub fn for_widget<W>(widget: W) -> Self

where W: MakeWidget,

Returns a new instance using widget as its contents.

pub fn focused(self, focused: impl IntoDynamic<bool>) -> Self

Sets focused to be the dynamic updated when this window’s focus status is changed.

When the window is focused for user input, the dynamic will contain true.

focused will be initialized with an initial state of false.

pub fn occluded(self, occluded: impl IntoDynamic<bool>) -> Self

Sets occluded to be the dynamic updated when this window’s occlusion status is changed.

When the window is occluded (completely hidden/offscreen/minimized), the dynamic will contain true. If the window is at least partially visible, this value will contain true.

occluded will be initialized with an initial state of false.

pub fn inner_size(self, inner_size: impl IntoDynamic<Size<UPx>>) -> Self

Sets inner_size to be the dynamic syncrhonized with this window’s inner size.

When the window is resized, the dynamic will contain its new size. When the dynamic is updated with a new value, a resize request will be made with the new inner size.

pub fn themed_mode(self, theme_mode: impl IntoValue<ThemeMode>) -> Self

Sets the ThemeMode for this window.

If a ThemeMode is provided, the window will be set to this theme mode upon creation and will not be updated while the window is running.

If a Dynamic is provided, the initial value will be ignored and the dynamic will be updated when the window opens with the user’s current theme mode. The dynamic will also be updated any time the user’s theme mode changes.

Setting the Dynamic’s value will also update the window with the new mode until a mode change is detected, upon which the new mode will be stored.

pub fn themed(self, theme: impl IntoValue<ThemePair>) -> Self

Applies theme to the widgets in this window.

pub fn loading_font(self, font_data: Vec<u8>) -> Self

Adds font_data to the list of fonts to load for availability when rendering.

All font families contained in font_data will be loaded.

pub fn on_close<Function>(self, on_close: Function) -> Self

where Function: FnOnce() + Send + 'static,

Invokes on_close when this window is closed.

pub fn titled(self, title: impl IntoValue<String>) -> Self

Sets the window’s title.

impl<Behavior> Window<Behavior>

where Behavior: WindowBehavior,

pub fn new(context: Behavior::Context) -> Self

Returns a new instance using context to initialize the window upon opening.

Trait Implementations

impl<Behavior> Default for Window<Behavior>

where Behavior: WindowBehavior, Behavior::Context: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<Behavior> Open for Window<Behavior>

where Behavior: WindowBehavior,

fn open<App>(self, app: &mut App) -> Result<Option<WindowHandle>>

where App: Application + ?Sized,

Opens the provided type as a window inside of app.

fn run_in(self, app: PendingApp) -> Result

Runs the provided type inside of the pending app, returning Ok(()) upon successful execution and program exit. Note that this function may not ever return on some platforms.

impl<Behavior> Run for Window<Behavior>

where Behavior: WindowBehavior,

fn run(self) -> Result

Runs the provided type, returning Ok(()) upon successful execution and program exit. Note that this function may not ever return on some platforms.