结构体 Window 

pub struct Window { /* private fields */ }

表示一个可以被捕获的窗口。

示例

use windows_capture::window::Window;

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

    Ok(())
}

实现

impl Window

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

返回当前位于前台的窗口。

错误

• Error::NoActiveWindow 当不存在前台窗口时

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

通过精确的标题查找窗口。

错误

• Error::WindowsError 当底层的 FindWindowW 调用失败时
• Error::NotFound 当未找到具有指定标题的窗口时

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

查找标题包含给定子串的窗口。

错误

• Error::WindowsError 当枚举窗口失败时
• Error::FailedToConvertWindowsString 当从 UTF-16 转换窗口标题失败时
• Error::NotFound 当没有窗口标题包含指定的子串时

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

返回窗口的标题。

错误

• Error::FailedToConvertWindowsString 当从 UTF-16 转换窗口标题失败时

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

返回窗口的进程 ID。

错误

• Error::WindowsError 当 GetWindowThreadProcessId 报告错误时

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

返回拥有该窗口的进程名称。

此函数需要 PROCESS_QUERY_INFORMATION 和 PROCESS_VM_READ 权限。

错误

• Error::WindowsError 当打开进程或查询其基础模块名称失败时
• Error::FailedToConvertWindowsString 当从 UTF-16 转换进程名称失败时

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

返回与窗口相交面积最大的显示器。

如果窗口不与任何显示器相交，则返回 None。

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

返回窗口在屏幕坐标中的边界矩形。

错误

• Error::WindowsError 当 GetWindowRect 失败时

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

计算窗口标题栏的高度（以像素为单位）。

错误

• Error::WindowsError 当 DwmGetWindowAttribute 或 GetClientRect 失败时

pub fn is_valid(&self) -> bool

检查窗口是否是有效的捕获目标。

返回值

如果窗口可见、不是工具窗口且不是子窗口，则返回 true。 否则返回 false。

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

返回所有可捕获窗口的列表。

错误

• Error::WindowsError 当 EnumChildWindows 失败时

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

返回窗口的宽度（以像素为单位）。

错误

• Error::WindowsError 当获取窗口矩形失败时

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

返回窗口的高度（以像素为单位）。

错误

• Error::WindowsError 当获取窗口矩形失败时

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

从原始的 HWND 句柄构造一个 Window 实例。

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

返回窗口的原始 HWND 句柄。

trait 实现

impl Clone for Window

fn clone(&self) -> Window

返回该值的副本。 了解更多

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

从 source 执行复制赋值。 了解更多

impl Debug for Window

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

使用给定的格式化器格式化该值。 了解更多

impl PartialEq for Window

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

测试 self 和 other 的值是否相等，由 == 使用。

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

测试 !=。默认实现几乎总是足够的，除非有非常充分的理由，否则不应被重写。

impl TryInto<GraphicsCaptureItemType> for Window

type Error = Error

在转换出错时返回的类型。

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

执行转换。

impl Copy for Window

impl Eq for Window

impl Send for Window

impl StructuralPartialEq for Window