Struct Window

pub struct Window { /* private fields */ }

Represents a window in the Windows operating system.

Example

use windows_capture::window::Window;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let window = Window::foreground()?;
    println!("Foreground window title: {}", window.title()?);

    Ok(())
}

Implementations

impl Window

pub fn foreground() -> Result<Self, Error>

Returns the foreground window.

Errors

Returns an Error::NoActiveWindow if there is no active window.

pub fn from_name(title: &str) -> Result<Self, Error>

Creates a Window instance from a window name.

Arguments

• title - The name of the window.

Errors

Returns an Error::NotFound if the window is not found.

pub fn from_contains_name(title: &str) -> Result<Self, Error>

Creates a Window instance from a window name substring.

Arguments

• title - The substring to search for in window names.

Errors

Returns an Error::NotFound if no window with a matching name substring is found.

pub fn title(&self) -> Result<String, Error>

Returns the title of the window.

Errors

Returns an Error if there is an error retrieving the window title.

pub fn process_id(&self) -> Result<u32, Error>

Returns the process name of the window.

Errors

Returns an Error if there is an error retrieving the process name.

pub fn process_name(&self) -> Result<String, Error>

Returns the process name of the window.

Requires the PROCESS_QUERY_INFORMATION and PROCESS_VM_READ permissions.

Errors

Returns an Error if there is an error retrieving the process name.

pub fn monitor(&self) -> Option<Monitor>

Returns the monitor that has the largest area of intersection with the window.

Returns None if the window doesn’t intersect with any monitor.

pub fn rect(&self) -> Result<RECT, Error>

Returns the rectangle of the window in screen coordinates.

Errors

Returns an Error::WindowsError if there is an error retrieving the window rectangle.

pub fn is_valid(&self) -> bool

Checks if the window is a valid window.

Returns

Returns true if the window is valid, false otherwise.

pub fn enumerate() -> Result<Vec<Self>, Error>

Returns a list of all windows.

Errors

Returns an Error if there is an error enumerating the windows.

pub const fn from_raw_hwnd(hwnd: *mut c_void) -> Self

Creates a Window instance from a raw HWND.

Arguments

• hwnd - The raw HWND.

pub const fn as_raw_hwnd(&self) -> *mut c_void

Returns the raw HWND of the window.

Trait Implementations

impl Clone for Window

fn clone(&self) -> Window

Returns a copy of the value.

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

Performs copy-assignment from source.

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: &Window) -> 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 TryFrom<Window> for GraphicsCaptureItem

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Window) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Window

impl Eq for Window

impl Send for Window

impl StructuralPartialEq for Window