Struct Window 

pub struct Window {
    pub title: String,
    pub width: u32,
    pub height: u32,
    pub mode: WindowMode,
    pub resizable: bool,
    pub title_bar: bool,
}

Declares the application window.

{
  "name": "main_window",
  "type": "Window",
  "args": {
    "title": "Game",
    "width": 1280,
    "height": 720,
    "mode": "windowed",
    "resizable": true,
    "title_bar": true
  }
}

Fields

title: String

Window title shown in the title bar.

width: u32

Initial window width in pixels.

height: u32

Initial window height in pixels.

mode: WindowMode

How the window is displayed.

resizable: bool

Whether the user can resize the window.

title_bar: bool

Whether the title bar is drawn, letting content fill the frame when it is not. Only applies to windowed mode: borderless has no title bar by definition, and fullscreen leaves the chrome to the OS.

Platforms differ in what survives the title bar. macOS keeps the close / minimize / zoom buttons floating over the content, so the window stays movable and closable. Windows and Linux draw their controls in the title bar, so turning it off there also removes them: the window can still be resized from its border, but offers no close button and cannot be dragged.

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Window

const NAME: &'static str = "Window"

The registry name a world authors this component under.

fn from_baked(bytes: &[u8]) -> Result<Window, CnResult>

Reconstruct this component from a blob record, whose bytes are the serialized runtime component (cook already ran the asset -> component translation). The default rejects: runtime-only components are never stored in a blob, so only loadable types provide an implementation.

fn inject_locator(&mut self, _locator: PayloadLocator)

Called after construction to inject the payload locator from the blob def. Only meaningful for components with a compiled payload. The default implementation does nothing (correct for most components).

fn inject_name(&mut self, _id: AssetId)

Called after construction to inject the asset’s identity from the blob def. Only meaningful for components that look themselves up by id at runtime. The default implementation does nothing.

impl ComponentSlot for Window

const DISCRIMINANT: u8

The component type’s stable id, used as its ComponentId.

fn slot(s: &ComponentStorage) -> &Column<Window>

Borrow this type’s column out of the storage.

fn slot_mut(s: &mut ComponentStorage) -> &mut Column<Window>

Mutably borrow this type’s column out of the storage.

impl Debug for Window

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

Formats the value using the given formatter.

impl Default for Window

fn default() -> Window

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Window

where Window: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Window, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Window> for ComponentAsset

fn from(c: Window) -> ComponentAsset

Converts to this type from the input type.

impl RuntimeComponent for Window

impl Serialize for Window

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.