Struct Window 

pub struct Window {
    pub window_type: WindowType,
    pub state: WindowState,
    pub top_left: Point,
    pub size: Size,
    pub depth_layer: DepthLayer,
    pub name: String,
    pub transform: Mat4,
    pub alpha: f32,
    /* private fields */
}

A window’s state, exposed to plugin callbacks and to crate::plugin::managed_windows.

Read-only fields describe the window at the time of the callback. Setter methods (set_state, set_rectangle, etc.) are available for windows returned by crate::plugin::managed_windows.

Fields

window_type: WindowType

The type of this window.

state: WindowState

The state of the window.

top_left: Point

The position of the window.

size: Size

The size of the window.

depth_layer: DepthLayer

The depth layer of the window.

name: String

The name of the window.

transform: Mat4

The 4x4 transform matrix of the window (column-major).

alpha: f32

The alpha (opacity) of the window.

Implementations

impl Window

pub fn id(&self) -> u64

Retrieve the ID of this window.

Plugins may elect to keep a reference to this ID so that they can match it with Window later.

pub fn application(&self) -> Option<ApplicationInfo>

Get the application that owns this window.

pub fn container(&self) -> Option<Container>

Get the container that holds this window.

pub fn workspace(&self) -> Option<Workspace>

Get the workspace that this window is on.

pub fn set_state(&self, state: WindowState) -> Result<(), ()>

Set the state of this window.

pub fn set_workspace(&self, workspace: &Workspace) -> Result<(), ()>

Move this window to a different workspace.

pub fn set_rectangle(&self, rect: Rectangle, animate: bool) -> Result<(), ()>

Set the position and size of this window.

pub fn set_transform(&self, transform: Mat4) -> Result<(), ()>

Set the 4x4 column-major transform matrix of this window.

pub fn set_alpha(&self, alpha: f32) -> Result<(), ()>

Set the alpha (opacity) of this window.

pub fn request_focus(&self) -> Result<(), ()>

Request keyboard focus on this window.

pub fn set_shader(&self, shader_id: Option<u8>) -> Result<(), ()>

Set the custom shader applied to this window.

Pass Some(id) with the ID returned by register_window_sample_to_rgba to activate the shader, or None to clear any custom shader and revert to default rendering.

Trait Implementations

impl Debug for Window

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

Formats the value using the given formatter.

impl PartialEq for Window

fn eq(&self, other: &Self) -> 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.