Struct Window 

pub struct Window { /* private fields */ }

Represents a window that can be captured.

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 window that is currently in the foreground.

Errors

• Error::NoActiveWindow when there is no foreground window

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

Finds a window by its exact title.

Errors

• Error::WindowsError when the underlying FindWindowW call fails
• Error::NotFound when no window with the specified title is found

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

Finds a window whose title contains the given substring.

Errors

• Error::WindowsError when enumerating windows fails
• Error::FailedToConvertWindowsString when converting a window title from UTF-16 fails
• Error::NotFound when no window title contains the specified substring

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

Returns the title of the window.

Errors

• Error::FailedToConvertWindowsString when converting the window title from UTF-16 fails

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

Returns the process ID of the window.

Errors

• Error::WindowsError when GetWindowThreadProcessId reports an error

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

Returns the name of the process that owns the window.

This function requires the PROCESS_QUERY_INFORMATION and PROCESS_VM_READ permissions.

Errors

• Error::WindowsError when opening the process or querying its base module name fails
• Error::FailedToConvertWindowsString when converting the process name from UTF-16 fails

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

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

Returns None if the window does not intersect with any monitor.

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

Returns the bounding rectangle of the window in screen coordinates.

Errors

• Error::WindowsError when GetWindowRect fails

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

Calculates the height of the window’s title bar in pixels.

Errors

• Error::WindowsError when DwmGetWindowAttribute or GetClientRect fails

pub fn is_valid(&self) -> bool

Checks whether the window is a valid target for capture.

Returns

Returns true if the window is visible, not a tool window, and not a child window. Returns false otherwise.

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

Returns a list of all capturable windows.

Errors

• Error::WindowsError when EnumWindows fails

pub fn width(&self) -> Result<i32, Error>

Returns the width of the window in pixels.

Errors

• Error::WindowsError when retrieving the window rectangle fails

pub fn height(&self) -> Result<i32, Error>

Returns the height of the window in pixels.

Errors

• Error::WindowsError when retrieving the window rectangle fails

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

Constructs a Window instance from a raw HWND handle.

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

Returns the raw HWND handle of the window.

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 Copy for Window

impl Debug for Window

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

Formats the value using the given formatter.

impl Eq for Window

impl PartialEq for Window

fn eq(&self, other: &Window) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Send for Window

impl StructuralPartialEq for Window

impl TryInto<GraphicsCaptureItemType> for Window

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<GraphicsCaptureItemType, Self::Error>

Performs the conversion.