diff --git a/Cargo.toml b/Cargo.toml index c37bff97..a7056c7c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "crabgrab" description = "A cross-platform screen/window capture crate" -version = "0.2.0" +version = "0.2.1" edition = "2021" authors = ["Augmend, Inc. ", "Liam Taylor ", "Tim Misiak "] documentation = "https://docs.rs/crabgrab" diff --git a/docs/macos_docs/crabgrab/all.html b/docs/macos_docs/crabgrab/all.html index 33fb10ae..b3e7db57 100644 --- a/docs/macos_docs/crabgrab/all.html +++ b/docs/macos_docs/crabgrab/all.html @@ -1,2 +1,2 @@ -List of all items in this crate -

List of all items

Structs

Enums

Traits

Functions

\ No newline at end of file +List of all items in this crate +

List of all items

Structs

Enums

Traits

Functions

\ No newline at end of file diff --git a/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html b/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html index dbcd8fba..0d4fb4db 100644 --- a/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html +++ b/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html @@ -1,4 +1,4 @@ -CapturableContentError in crabgrab::capturable_content - Rust +CapturableContentError in crabgrab::capturable_content - Rust
pub enum CapturableContentError {
     Other(String),
 }
Expand description

Represents an error that occurred when enumerating capturable content

diff --git a/docs/macos_docs/crabgrab/capturable_content/index.html b/docs/macos_docs/crabgrab/capturable_content/index.html index f21e23dc..8d2a4bce 100644 --- a/docs/macos_docs/crabgrab/capturable_content/index.html +++ b/docs/macos_docs/crabgrab/capturable_content/index.html @@ -1,3 +1,3 @@ -crabgrab::capturable_content - Rust -
Expand description

Enumeration of capturable items

+crabgrab::capturable_content - Rust +
Expand description

Enumeration of capturable items

Structs§

Enums§

\ No newline at end of file diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableApplication.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableApplication.html index d3d36b24..e1ef08b3 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableApplication.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableApplication.html @@ -1,7 +1,8 @@ -CapturableApplication in crabgrab::capturable_content - Rust +CapturableApplication in crabgrab::capturable_content - Rust
pub struct CapturableApplication { /* private fields */ }
Expand description

Represents an application with capturable windows

-

Implementations§

source§

impl CapturableApplication

source

pub fn identifier(&self) -> String

Gets the “identifier” of the application

+

Implementations§

source§

impl CapturableApplication

source

pub fn identifier(&self) -> String

Gets the “identifier” of the application

On MacOS, this is the application bundle, and on windows, this is the application file name

+
source

pub fn name(&self) -> String

Gets the friendly name of the application

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContent.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContent.html index 1c644287..4335952e 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContent.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContent.html @@ -1,4 +1,4 @@ -CapturableContent in crabgrab::capturable_content - Rust +CapturableContent in crabgrab::capturable_content - Rust
pub struct CapturableContent { /* private fields */ }
Expand description

A collection of capturable content (windows, screens)

Implementations§

source§

impl CapturableContent

source

pub async fn new( filter: CapturableContentFilter diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html index f299ec01..be5b2c74 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html @@ -1,4 +1,4 @@ -CapturableContentFilter in crabgrab::capturable_content - Rust +CapturableContentFilter in crabgrab::capturable_content - Rust
pub struct CapturableContentFilter {
     pub windows: Option<CapturableWindowFilter>,
     pub displays: bool,
diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplay.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplay.html
index 709f4c58..9d07452a 100644
--- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplay.html
+++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplay.html
@@ -1,4 +1,4 @@
-CapturableDisplay in crabgrab::capturable_content - Rust
+CapturableDisplay in crabgrab::capturable_content - Rust
     
pub struct CapturableDisplay { /* private fields */ }
Expand description

Represents a capturable display

Implementations§

source§

impl CapturableDisplay

source

pub fn rect(&self) -> Rect

Gets the virtual screen rectangle of this display

Note: Currently on windows, this is only evaluated at the time of display enumeration

diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html index e624c5cc..dc1da2c2 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html @@ -1,4 +1,4 @@ -CapturableDisplayIterator in crabgrab::capturable_content - Rust +CapturableDisplayIterator in crabgrab::capturable_content - Rust
pub struct CapturableDisplayIterator<'content> { /* private fields */ }
Expand description

An iterator over capturable displays

Trait Implementations§

source§

impl ExactSizeIterator for CapturableDisplayIterator<'_>

source§

fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more
source§

fn is_empty(&self) -> bool

🔬This is a nightly-only experimental API. (exact_size_is_empty)
Returns true if the iterator is empty. Read more
source§

impl Iterator for CapturableDisplayIterator<'_>

§

type Item = CapturableDisplay

The type of the elements being iterated over.
source§

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value. Read more
source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more
source§

fn next_chunk<const N: usize>( &mut self diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindow.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindow.html index b503a9a5..2ee620d2 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindow.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindow.html @@ -1,4 +1,4 @@ -CapturableWindow in crabgrab::capturable_content - Rust +CapturableWindow in crabgrab::capturable_content - Rust
pub struct CapturableWindow { /* private fields */ }
Expand description

Represents a capturable application window

Implementations§

source§

impl CapturableWindow

source

pub fn title(&self) -> String

Gets the title of the window

source

pub fn rect(&self) -> Rect

Gets the virtual screen rectangle of the window

@@ -6,7 +6,8 @@
source

pub fn is_visible(&self) -> bool

Checks whether an application is visible (on-screen, not minimized)

Trait Implementations§

source§

impl Clone for CapturableWindow

source§

fn clone(&self) -> CapturableWindow

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CapturableWindow

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for CapturableWindow

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, - Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for CapturableWindow

source§

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

This method tests for self and other values to be equal, and is used + Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl MacosCapturableWindowNativeWindowId for CapturableWindow

source§

fn get_native_window_id(&self) -> u32

Get the native window id for this capturable window. +This is the CGWindowID for this window.
source§

impl PartialEq for CapturableWindow

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for CapturableWindow

source§

impl Send for CapturableWindow

source§

impl StructuralPartialEq for CapturableWindow

source§

impl Sync for CapturableWindow

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html index e29ec9ab..52ea8f04 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html @@ -1,4 +1,4 @@ -CapturableWindowFilter in crabgrab::capturable_content - Rust +CapturableWindowFilter in crabgrab::capturable_content - Rust
pub struct CapturableWindowFilter {
     pub desktop_windows: bool,
     pub onscreen_only: bool,
diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html
index 5df0e797..ed3bd5f6 100644
--- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html
+++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html
@@ -1,4 +1,4 @@
-CapturableWindowIterator in crabgrab::capturable_content - Rust
+CapturableWindowIterator in crabgrab::capturable_content - Rust
     
pub struct CapturableWindowIterator<'content> { /* private fields */ }
Expand description

An iterator over capturable windows

Trait Implementations§

source§

impl ExactSizeIterator for CapturableWindowIterator<'_>

1.0.0 · source§

fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more
source§

fn is_empty(&self) -> bool

🔬This is a nightly-only experimental API. (exact_size_is_empty)
Returns true if the iterator is empty. Read more
source§

impl Iterator for CapturableWindowIterator<'_>

§

type Item = CapturableWindow

The type of the elements being iterated over.
source§

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value. Read more
source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more
source§

fn next_chunk<const N: usize>( &mut self diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.CaptureConfigError.html b/docs/macos_docs/crabgrab/capture_stream/enum.CaptureConfigError.html index 2418fdd6..f9398832 100644 --- a/docs/macos_docs/crabgrab/capture_stream/enum.CaptureConfigError.html +++ b/docs/macos_docs/crabgrab/capture_stream/enum.CaptureConfigError.html @@ -1,4 +1,4 @@ -CaptureConfigError in crabgrab::capture_stream - Rust +CaptureConfigError in crabgrab::capture_stream - Rust
pub enum CaptureConfigError {
     UnsupportedPixelFormat,
     InvalidBufferCount,
diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html b/docs/macos_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html
index bf0da0ce..93d2c79e 100644
--- a/docs/macos_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html
+++ b/docs/macos_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html
@@ -1,4 +1,4 @@
-CapturePixelFormat in crabgrab::capture_stream - Rust
+CapturePixelFormat in crabgrab::capture_stream - Rust
     
#[non_exhaustive]
pub enum CapturePixelFormat { Bgra8888, Argb2101010, diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.StreamCreateError.html b/docs/macos_docs/crabgrab/capture_stream/enum.StreamCreateError.html index 492da7df..c659c39b 100644 --- a/docs/macos_docs/crabgrab/capture_stream/enum.StreamCreateError.html +++ b/docs/macos_docs/crabgrab/capture_stream/enum.StreamCreateError.html @@ -1,10 +1,10 @@ -StreamCreateError in crabgrab::capture_stream - Rust +StreamCreateError in crabgrab::capture_stream - Rust
pub enum StreamCreateError {
     Other(String),
     UnsupportedPixelFormat,
 }
Expand description

This represents an error when creating a capture stream

Variants§

§

Other(String)

§

UnsupportedPixelFormat

The supplied pixel format is unsupported by the implementation

-

Trait Implementations§

source§

impl Clone for StreamCreateError

source§

fn clone(&self) -> StreamCreateError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for StreamCreateError

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for StreamCreateError

source§

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

Formats the value using the given formatter. Read more
source§

impl Error for StreamCreateError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl Send for StreamCreateError

source§

impl Sync for StreamCreateError

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

Trait Implementations§

source§

impl Clone for StreamCreateError

source§

fn clone(&self) -> StreamCreateError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for StreamCreateError

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for StreamCreateError

source§

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

Formats the value using the given formatter. Read more
source§

impl Error for StreamCreateError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl Send for StreamCreateError

source§

impl Sync for StreamCreateError

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.StreamError.html b/docs/macos_docs/crabgrab/capture_stream/enum.StreamError.html index 3b5a81eb..a2094d54 100644 --- a/docs/macos_docs/crabgrab/capture_stream/enum.StreamError.html +++ b/docs/macos_docs/crabgrab/capture_stream/enum.StreamError.html @@ -1,8 +1,8 @@ -StreamError in crabgrab::capture_stream - Rust +StreamError in crabgrab::capture_stream - Rust
pub enum StreamError {
     Other(String),
 }
Expand description

This represents an error during a stream, for example a failure to retrieve a video or audio frame

-

Variants§

§

Other(String)

Trait Implementations§

source§

impl Clone for StreamError

source§

fn clone(&self) -> StreamError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for StreamError

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for StreamError

source§

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

Formats the value using the given formatter. Read more
source§

impl Error for StreamError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

Variants§

§

Other(String)

Trait Implementations§

source§

impl Clone for StreamError

source§

fn clone(&self) -> StreamError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for StreamError

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for StreamError

source§

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

Formats the value using the given formatter. Read more
source§

impl Error for StreamError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.StreamEvent.html b/docs/macos_docs/crabgrab/capture_stream/enum.StreamEvent.html index ff7b9751..0ed1f19e 100644 --- a/docs/macos_docs/crabgrab/capture_stream/enum.StreamEvent.html +++ b/docs/macos_docs/crabgrab/capture_stream/enum.StreamEvent.html @@ -1,4 +1,4 @@ -StreamEvent in crabgrab::capture_stream - Rust +StreamEvent in crabgrab::capture_stream - Rust
pub enum StreamEvent {
     Audio(AudioFrame),
     Video(VideoFrame),
diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.StreamStopError.html b/docs/macos_docs/crabgrab/capture_stream/enum.StreamStopError.html
index 8e470b9a..61532b0b 100644
--- a/docs/macos_docs/crabgrab/capture_stream/enum.StreamStopError.html
+++ b/docs/macos_docs/crabgrab/capture_stream/enum.StreamStopError.html
@@ -1,4 +1,4 @@
-StreamStopError in crabgrab::capture_stream - Rust
+StreamStopError in crabgrab::capture_stream - Rust
     
pub enum StreamStopError {
     Other(String),
     AlreadyStopped,
diff --git a/docs/macos_docs/crabgrab/capture_stream/index.html b/docs/macos_docs/crabgrab/capture_stream/index.html
index 9a41ad75..d948bb48 100644
--- a/docs/macos_docs/crabgrab/capture_stream/index.html
+++ b/docs/macos_docs/crabgrab/capture_stream/index.html
@@ -1,3 +1,3 @@
-crabgrab::capture_stream - Rust
+crabgrab::capture_stream - Rust
     
Expand description

The actual capture stream and related constructs

Structs§

Enums§

\ No newline at end of file diff --git a/docs/macos_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html b/docs/macos_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html index 68f79ba4..dbd4da9a 100644 --- a/docs/macos_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html +++ b/docs/macos_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html @@ -1,4 +1,4 @@ -AudioCaptureConfig in crabgrab::capture_stream - Rust +AudioCaptureConfig in crabgrab::capture_stream - Rust
pub struct AudioCaptureConfig { /* private fields */ }
Expand description

Configuration settings for audio streams

Implementations§

source§

impl AudioCaptureConfig

source

pub fn new() -> Self

Creates a new audio capture config with default settings:

    diff --git a/docs/macos_docs/crabgrab/capture_stream/struct.CaptureAccessToken.html b/docs/macos_docs/crabgrab/capture_stream/struct.CaptureAccessToken.html index e8333c15..10478774 100644 --- a/docs/macos_docs/crabgrab/capture_stream/struct.CaptureAccessToken.html +++ b/docs/macos_docs/crabgrab/capture_stream/struct.CaptureAccessToken.html @@ -1,4 +1,4 @@ -CaptureAccessToken in crabgrab::capture_stream - Rust +CaptureAccessToken in crabgrab::capture_stream - Rust
    pub struct CaptureAccessToken { /* private fields */ }
    Expand description

    Represents programmatic capture access

    Implementations§

    Trait Implementations§

    source§

    impl Clone for CaptureAccessToken

    source§

    fn clone(&self) -> CaptureAccessToken

    Returns a copy of the value. Read more
    1.0.0 · source§

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

    Performs copy-assignment from source. Read more
    source§

    impl Debug for CaptureAccessToken

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Copy for CaptureAccessToken

    source§

    impl Send for CaptureAccessToken

    source§

    impl Sync for CaptureAccessToken

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where diff --git a/docs/macos_docs/crabgrab/capture_stream/struct.CaptureConfig.html b/docs/macos_docs/crabgrab/capture_stream/struct.CaptureConfig.html index 96bcee19..1b05343b 100644 --- a/docs/macos_docs/crabgrab/capture_stream/struct.CaptureConfig.html +++ b/docs/macos_docs/crabgrab/capture_stream/struct.CaptureConfig.html @@ -1,4 +1,4 @@ -CaptureConfig in crabgrab::capture_stream - Rust +CaptureConfig in crabgrab::capture_stream - Rust
    pub struct CaptureConfig { /* private fields */ }
    Expand description

    Configuration settings for a capture stream

    Implementations§

    source§

    impl CaptureConfig

    source

    pub fn with_window( window: CapturableWindow, diff --git a/docs/macos_docs/crabgrab/capture_stream/struct.CaptureStream.html b/docs/macos_docs/crabgrab/capture_stream/struct.CaptureStream.html index d2521674..210fb87d 100644 --- a/docs/macos_docs/crabgrab/capture_stream/struct.CaptureStream.html +++ b/docs/macos_docs/crabgrab/capture_stream/struct.CaptureStream.html @@ -1,4 +1,4 @@ -CaptureStream in crabgrab::capture_stream - Rust +CaptureStream in crabgrab::capture_stream - Rust
    pub struct CaptureStream { /* private fields */ }
    Expand description

    Represents an active capture stream

    Implementations§

    source§

    impl CaptureStream

    source

    pub fn test_access(borderless: bool) -> Option<CaptureAccessToken>

    Test whether the calling application has permission to capture content

    source

    pub async fn request_access(borderless: bool) -> Option<CaptureAccessToken>

    Prompt the user for permission to capture content

    diff --git a/docs/macos_docs/crabgrab/feature/bitmap/enum.FrameBitmap.html b/docs/macos_docs/crabgrab/feature/bitmap/enum.FrameBitmap.html index c06dd0fc..bd0a703e 100644 --- a/docs/macos_docs/crabgrab/feature/bitmap/enum.FrameBitmap.html +++ b/docs/macos_docs/crabgrab/feature/bitmap/enum.FrameBitmap.html @@ -1,4 +1,4 @@ -FrameBitmap in crabgrab::feature::bitmap - Rust +FrameBitmap in crabgrab::feature::bitmap - Rust
    pub enum FrameBitmap {
         BgraUnorm8x4(FrameBitmapBgraUnorm8x4),
         RgbaUnormPacked1010102(FrameBitmapRgbaUnormPacked1010102),
    diff --git a/docs/macos_docs/crabgrab/feature/bitmap/enum.VideoFrameBitmapError.html b/docs/macos_docs/crabgrab/feature/bitmap/enum.VideoFrameBitmapError.html
    index e9415252..4009a493 100644
    --- a/docs/macos_docs/crabgrab/feature/bitmap/enum.VideoFrameBitmapError.html
    +++ b/docs/macos_docs/crabgrab/feature/bitmap/enum.VideoFrameBitmapError.html
    @@ -1,8 +1,8 @@
    -VideoFrameBitmapError in crabgrab::feature::bitmap - Rust
    +VideoFrameBitmapError in crabgrab::feature::bitmap - Rust
         
    pub enum VideoFrameBitmapError {
         Other(String),
     }
    Expand description

    Represents an error while generating a frame bitmap

    -

    Variants§

    §

    Other(String)

    Trait Implementations§

    source§

    impl Clone for VideoFrameBitmapError

    source§

    fn clone(&self) -> VideoFrameBitmapError

    Returns a copy of the value. Read more
    1.0.0 · source§

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

    Performs copy-assignment from source. Read more
    source§

    impl Debug for VideoFrameBitmapError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Display for VideoFrameBitmapError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Error for VideoFrameBitmapError

    source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where +

    Variants§

    §

    Other(String)

    Trait Implementations§

    source§

    impl Clone for VideoFrameBitmapError

    source§

    fn clone(&self) -> VideoFrameBitmapError

    Returns a copy of the value. Read more
    1.0.0 · source§

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

    Performs copy-assignment from source. Read more
    source§

    impl Debug for VideoFrameBitmapError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Display for VideoFrameBitmapError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Error for VideoFrameBitmapError

    source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where T: ?Sized,

    source§

    fn borrow(&self) -> &T

    Immutably borrows from an owned value. Read more
    source§

    impl<T> BorrowMut<T> for T
    where T: ?Sized,

    source§

    fn borrow_mut(&mut self) -> &mut T

    Mutably borrows from an owned value. Read more
    source§

    impl<T> From<T> for T

    source§

    fn from(t: T) -> T

    Returns the argument unchanged.

    diff --git a/docs/macos_docs/crabgrab/feature/bitmap/enum.VideoRange.html b/docs/macos_docs/crabgrab/feature/bitmap/enum.VideoRange.html index a87d838c..ccb704f7 100644 --- a/docs/macos_docs/crabgrab/feature/bitmap/enum.VideoRange.html +++ b/docs/macos_docs/crabgrab/feature/bitmap/enum.VideoRange.html @@ -1,4 +1,4 @@ -VideoRange in crabgrab::feature::bitmap - Rust +VideoRange in crabgrab::feature::bitmap - Rust
    pub enum VideoRange {
         Video,
         Full,
    diff --git a/docs/macos_docs/crabgrab/feature/bitmap/index.html b/docs/macos_docs/crabgrab/feature/bitmap/index.html
    index 59b3bc48..18029dd6 100644
    --- a/docs/macos_docs/crabgrab/feature/bitmap/index.html
    +++ b/docs/macos_docs/crabgrab/feature/bitmap/index.html
    @@ -1,4 +1,4 @@
    -crabgrab::feature::bitmap - Rust
    +crabgrab::feature::bitmap - Rust
         

    Module crabgrab::feature::bitmap

    source ·
    Expand description

    Frame to Bitmap conversion (requires bitmap feature)

    Structs§

    Enums§

    Traits§

    \ No newline at end of file diff --git a/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapBgraUnorm8x4.html b/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapBgraUnorm8x4.html index 028ffedb..fbc2b322 100644 --- a/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapBgraUnorm8x4.html +++ b/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapBgraUnorm8x4.html @@ -1,4 +1,4 @@ -FrameBitmapBgraUnorm8x4 in crabgrab::feature::bitmap - Rust +FrameBitmapBgraUnorm8x4 in crabgrab::feature::bitmap - Rust
    pub struct FrameBitmapBgraUnorm8x4 {
         pub data: Box<[[u8; 4]]>,
         pub width: usize,
    diff --git a/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaF16x4.html b/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaF16x4.html
    index c7493aac..6ca34c0d 100644
    --- a/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaF16x4.html
    +++ b/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaF16x4.html
    @@ -1,4 +1,4 @@
    -FrameBitmapRgbaF16x4 in crabgrab::feature::bitmap - Rust
    +FrameBitmapRgbaF16x4 in crabgrab::feature::bitmap - Rust
         
    pub struct FrameBitmapRgbaF16x4 {
         pub data: Box<[[f16; 4]]>,
         pub width: usize,
    diff --git a/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaUnormPacked1010102.html b/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaUnormPacked1010102.html
    index 5b788281..76f3eb6a 100644
    --- a/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaUnormPacked1010102.html
    +++ b/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaUnormPacked1010102.html
    @@ -1,4 +1,4 @@
    -FrameBitmapRgbaUnormPacked1010102 in crabgrab::feature::bitmap - Rust
    +FrameBitmapRgbaUnormPacked1010102 in crabgrab::feature::bitmap - Rust
         
    pub struct FrameBitmapRgbaUnormPacked1010102 {
         pub data: Box<[u32]>,
         pub width: usize,
    diff --git a/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapYCbCr.html b/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapYCbCr.html
    index 32804ca0..08b7b37a 100644
    --- a/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapYCbCr.html
    +++ b/docs/macos_docs/crabgrab/feature/bitmap/struct.FrameBitmapYCbCr.html
    @@ -1,4 +1,4 @@
    -FrameBitmapYCbCr in crabgrab::feature::bitmap - Rust
    +FrameBitmapYCbCr in crabgrab::feature::bitmap - Rust
         
    pub struct FrameBitmapYCbCr {
         pub luma_data: Box<[u8]>,
         pub luma_width: usize,
    diff --git a/docs/macos_docs/crabgrab/feature/bitmap/trait.VideoFrameBitmap.html b/docs/macos_docs/crabgrab/feature/bitmap/trait.VideoFrameBitmap.html
    index 86dbeec3..f4e750d2 100644
    --- a/docs/macos_docs/crabgrab/feature/bitmap/trait.VideoFrameBitmap.html
    +++ b/docs/macos_docs/crabgrab/feature/bitmap/trait.VideoFrameBitmap.html
    @@ -1,4 +1,4 @@
    -VideoFrameBitmap in crabgrab::feature::bitmap - Rust
    +VideoFrameBitmap in crabgrab::feature::bitmap - Rust
         
    pub trait VideoFrameBitmap {
         // Required method
         fn get_bitmap(&self) -> Result<FrameBitmap, VideoFrameBitmapError>;
    diff --git a/docs/macos_docs/crabgrab/feature/index.html b/docs/macos_docs/crabgrab/feature/index.html
    index 14829840..747ebffe 100644
    --- a/docs/macos_docs/crabgrab/feature/index.html
    +++ b/docs/macos_docs/crabgrab/feature/index.html
    @@ -1,4 +1,4 @@
    -crabgrab::feature - Rust
    +crabgrab::feature - Rust
         

    Module crabgrab::feature

    source ·
    Expand description

    Extension features

    Modules§

    • Frame to Bitmap conversion (requires bitmap feature)
    • Frame -> IOSurface conversion diff --git a/docs/macos_docs/crabgrab/feature/iosurface/enum.GetIoSurfaceError.html b/docs/macos_docs/crabgrab/feature/iosurface/enum.GetIoSurfaceError.html index f9507d31..964fe174 100644 --- a/docs/macos_docs/crabgrab/feature/iosurface/enum.GetIoSurfaceError.html +++ b/docs/macos_docs/crabgrab/feature/iosurface/enum.GetIoSurfaceError.html @@ -1,11 +1,11 @@ -GetIoSurfaceError in crabgrab::feature::iosurface - Rust +GetIoSurfaceError in crabgrab::feature::iosurface - Rust
      pub enum GetIoSurfaceError {
           NoImageBuffer,
           NoIoSurface,
       }
      Expand description

      Represents an error when getting the IOSurface behind this video frame

      Variants§

      §

      NoImageBuffer

      There was no image buffer in this frame

      §

      NoIoSurface

      There was no IOSurface in the frame’s image buffer

      -

      Trait Implementations§

      source§

      impl Debug for GetIoSurfaceError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for GetIoSurfaceError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for GetIoSurfaceError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where +

      Trait Implementations§

      source§

      impl Debug for GetIoSurfaceError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for GetIoSurfaceError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for GetIoSurfaceError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where T: 'static + ?Sized,

      source§

      fn type_id(&self) -> TypeId

      Gets the TypeId of self. Read more
      source§

      impl<T> Borrow<T> for T
      where T: ?Sized,

      source§

      fn borrow(&self) -> &T

      Immutably borrows from an owned value. Read more
      source§

      impl<T> BorrowMut<T> for T
      where T: ?Sized,

      source§

      fn borrow_mut(&mut self) -> &mut T

      Mutably borrows from an owned value. Read more
      source§

      impl<T> From<T> for T

      source§

      fn from(t: T) -> T

      Returns the argument unchanged.

      diff --git a/docs/macos_docs/crabgrab/feature/iosurface/index.html b/docs/macos_docs/crabgrab/feature/iosurface/index.html index 7c05c220..d5c048ce 100644 --- a/docs/macos_docs/crabgrab/feature/iosurface/index.html +++ b/docs/macos_docs/crabgrab/feature/iosurface/index.html @@ -1,4 +1,4 @@ -crabgrab::feature::iosurface - Rust +crabgrab::feature::iosurface - Rust

      Module crabgrab::feature::iosurface

      source ·
      Expand description

      Frame -> IOSurface conversion (requires iosurface feature)

      Structs§

      Enums§

      • Represents an error when getting the IOSurface behind this video frame

      Traits§

      \ No newline at end of file diff --git a/docs/macos_docs/crabgrab/feature/iosurface/struct.IoSurface.html b/docs/macos_docs/crabgrab/feature/iosurface/struct.IoSurface.html index 31770056..0e7d6a96 100644 --- a/docs/macos_docs/crabgrab/feature/iosurface/struct.IoSurface.html +++ b/docs/macos_docs/crabgrab/feature/iosurface/struct.IoSurface.html @@ -1,4 +1,4 @@ -IoSurface in crabgrab::feature::iosurface - Rust +IoSurface in crabgrab::feature::iosurface - Rust
      pub struct IoSurface(/* private fields */);
      Expand description

      A MacOS IOSurface instance

      Implementations§

      source§

      impl IoSurface

      source

      pub fn get_raw(&self) -> *const c_void

      Gets the raw IOSurfaceRef

      Trait Implementations§

      source§

      impl Clone for IoSurface

      source§

      fn clone(&self) -> Self

      Returns a copy of the value. Read more
      1.0.0 · source§

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

      Performs copy-assignment from source. Read more
      source§

      impl Drop for IoSurface

      source§

      fn drop(&mut self)

      Executes the destructor for this type. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where diff --git a/docs/macos_docs/crabgrab/feature/iosurface/trait.MacosIoSurfaceVideoFrameExt.html b/docs/macos_docs/crabgrab/feature/iosurface/trait.MacosIoSurfaceVideoFrameExt.html index 3ab76c9f..671f75cf 100644 --- a/docs/macos_docs/crabgrab/feature/iosurface/trait.MacosIoSurfaceVideoFrameExt.html +++ b/docs/macos_docs/crabgrab/feature/iosurface/trait.MacosIoSurfaceVideoFrameExt.html @@ -1,4 +1,4 @@ -MacosIoSurfaceVideoFrameExt in crabgrab::feature::iosurface - Rust +MacosIoSurfaceVideoFrameExt in crabgrab::feature::iosurface - Rust
      pub trait MacosIoSurfaceVideoFrameExt {
           // Required method
           fn get_iosurface(&self) -> Result<IoSurface, GetIoSurfaceError>;
      diff --git a/docs/macos_docs/crabgrab/feature/metal/enum.MacosVideoFrameError.html b/docs/macos_docs/crabgrab/feature/metal/enum.MacosVideoFrameError.html
      index 083c355b..509cc4f7 100644
      --- a/docs/macos_docs/crabgrab/feature/metal/enum.MacosVideoFrameError.html
      +++ b/docs/macos_docs/crabgrab/feature/metal/enum.MacosVideoFrameError.html
      @@ -1,4 +1,4 @@
      -MacosVideoFrameError in crabgrab::feature::metal - Rust
      +MacosVideoFrameError in crabgrab::feature::metal - Rust
           
      pub enum MacosVideoFrameError {
           NoIoSurface,
           NoImageBuffer,
      diff --git a/docs/macos_docs/crabgrab/feature/metal/enum.MetalVideoFramePlaneTexture.html b/docs/macos_docs/crabgrab/feature/metal/enum.MetalVideoFramePlaneTexture.html
      index 0045a374..d37869b8 100644
      --- a/docs/macos_docs/crabgrab/feature/metal/enum.MetalVideoFramePlaneTexture.html
      +++ b/docs/macos_docs/crabgrab/feature/metal/enum.MetalVideoFramePlaneTexture.html
      @@ -1,4 +1,4 @@
      -MetalVideoFramePlaneTexture in crabgrab::feature::metal - Rust
      +MetalVideoFramePlaneTexture in crabgrab::feature::metal - Rust
           
      pub enum MetalVideoFramePlaneTexture {
           Rgba,
           Luminance,
      diff --git a/docs/macos_docs/crabgrab/feature/metal/index.html b/docs/macos_docs/crabgrab/feature/metal/index.html
      index 12fe6781..6b433305 100644
      --- a/docs/macos_docs/crabgrab/feature/metal/index.html
      +++ b/docs/macos_docs/crabgrab/feature/metal/index.html
      @@ -1,4 +1,4 @@
      -crabgrab::feature::metal - Rust
      +crabgrab::feature::metal - Rust
           

      Module crabgrab::feature::metal

      source ·
      Expand description

      Frame -> Metal Texture conversion (requires metal feature)

      Enums§

      Traits§

      \ No newline at end of file diff --git a/docs/macos_docs/crabgrab/feature/metal/trait.MetalCaptureStreamExt.html b/docs/macos_docs/crabgrab/feature/metal/trait.MetalCaptureStreamExt.html index e554f8b1..d011f153 100644 --- a/docs/macos_docs/crabgrab/feature/metal/trait.MetalCaptureStreamExt.html +++ b/docs/macos_docs/crabgrab/feature/metal/trait.MetalCaptureStreamExt.html @@ -1,4 +1,4 @@ -MetalCaptureStreamExt in crabgrab::feature::metal - Rust +MetalCaptureStreamExt in crabgrab::feature::metal - Rust
      pub trait MetalCaptureStreamExt {
           // Required method
           fn get_metal_device(&self) -> Device;
      diff --git a/docs/macos_docs/crabgrab/feature/metal/trait.MetalVideoFrameExt.html b/docs/macos_docs/crabgrab/feature/metal/trait.MetalVideoFrameExt.html
      index ab72fe2c..4777ebe8 100644
      --- a/docs/macos_docs/crabgrab/feature/metal/trait.MetalVideoFrameExt.html
      +++ b/docs/macos_docs/crabgrab/feature/metal/trait.MetalVideoFrameExt.html
      @@ -1,4 +1,4 @@
      -MetalVideoFrameExt in crabgrab::feature::metal - Rust
      +MetalVideoFrameExt in crabgrab::feature::metal - Rust
           
      pub trait MetalVideoFrameExt {
           // Required method
           fn get_metal_texture(
      diff --git a/docs/macos_docs/crabgrab/feature/screenshot/enum.ScreenshotError.html b/docs/macos_docs/crabgrab/feature/screenshot/enum.ScreenshotError.html
      index fd29d431..a3f51fe8 100644
      --- a/docs/macos_docs/crabgrab/feature/screenshot/enum.ScreenshotError.html
      +++ b/docs/macos_docs/crabgrab/feature/screenshot/enum.ScreenshotError.html
      @@ -1,4 +1,4 @@
      -ScreenshotError in crabgrab::feature::screenshot - Rust
      +ScreenshotError in crabgrab::feature::screenshot - Rust
           
      pub enum ScreenshotError {
           Other(String),
       }
      Expand description

      Represents an error while taking a screenshot

      diff --git a/docs/macos_docs/crabgrab/feature/screenshot/fn.take_screenshot.html b/docs/macos_docs/crabgrab/feature/screenshot/fn.take_screenshot.html index 281f1f4b..58ce3dca 100644 --- a/docs/macos_docs/crabgrab/feature/screenshot/fn.take_screenshot.html +++ b/docs/macos_docs/crabgrab/feature/screenshot/fn.take_screenshot.html @@ -1,4 +1,4 @@ -take_screenshot in crabgrab::feature::screenshot - Rust +take_screenshot in crabgrab::feature::screenshot - Rust
      pub async fn take_screenshot(
           token: CaptureAccessToken,
           config: CaptureConfig
      diff --git a/docs/macos_docs/crabgrab/feature/screenshot/index.html b/docs/macos_docs/crabgrab/feature/screenshot/index.html
      index 1ef74549..4a41ce93 100644
      --- a/docs/macos_docs/crabgrab/feature/screenshot/index.html
      +++ b/docs/macos_docs/crabgrab/feature/screenshot/index.html
      @@ -1,4 +1,4 @@
      -crabgrab::feature::screenshot - Rust
      +crabgrab::feature::screenshot - Rust
           
      Expand description

      Screenshot utility function (requires screenshot feature)

      Enums§

      Functions§

      • Take a screenshot of the capturable content given a configuration
      \ No newline at end of file diff --git a/docs/macos_docs/crabgrab/feature/wgpu/enum.WgpuVideoFrameError.html b/docs/macos_docs/crabgrab/feature/wgpu/enum.WgpuVideoFrameError.html index e916e361..c032ee1c 100644 --- a/docs/macos_docs/crabgrab/feature/wgpu/enum.WgpuVideoFrameError.html +++ b/docs/macos_docs/crabgrab/feature/wgpu/enum.WgpuVideoFrameError.html @@ -1,4 +1,4 @@ -WgpuVideoFrameError in crabgrab::feature::wgpu - Rust +WgpuVideoFrameError in crabgrab::feature::wgpu - Rust
      pub enum WgpuVideoFrameError {
           NoBackendTexture,
           InvalidVideoPlaneTexture,
      @@ -8,7 +8,7 @@
       

      Variants§

      §

      NoBackendTexture

      the backend texture couldn’t be fetched

      §

      InvalidVideoPlaneTexture

      The requested plane isn’t valid for this frame

      §

      NoWgpuDevice

      No Wgpu device was supplied to the capture stream

      -
      §

      Other(String)

      Trait Implementations§

      source§

      impl Clone for WgpuVideoFrameError

      source§

      fn clone(&self) -> WgpuVideoFrameError

      Returns a copy of the value. Read more
      1.0.0 · source§

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

      Performs copy-assignment from source. Read more
      source§

      impl Debug for WgpuVideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for WgpuVideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for WgpuVideoFrameError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where +
      §

      Other(String)

      Trait Implementations§

      source§

      impl Clone for WgpuVideoFrameError

      source§

      fn clone(&self) -> WgpuVideoFrameError

      Returns a copy of the value. Read more
      1.0.0 · source§

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

      Performs copy-assignment from source. Read more
      source§

      impl Debug for WgpuVideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for WgpuVideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for WgpuVideoFrameError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where T: 'static + ?Sized,

      source§

      fn type_id(&self) -> TypeId

      Gets the TypeId of self. Read more
      source§

      impl<T> Borrow<T> for T
      where T: ?Sized,

      source§

      fn borrow(&self) -> &T

      Immutably borrows from an owned value. Read more
      source§

      impl<T> BorrowMut<T> for T
      where T: ?Sized,

      source§

      fn borrow_mut(&mut self) -> &mut T

      Mutably borrows from an owned value. Read more
      source§

      impl<T> From<T> for T

      source§

      fn from(t: T) -> T

      Returns the argument unchanged.

      diff --git a/docs/macos_docs/crabgrab/feature/wgpu/enum.WgpuVideoFramePlaneTexture.html b/docs/macos_docs/crabgrab/feature/wgpu/enum.WgpuVideoFramePlaneTexture.html index 0f54877c..09fdbc80 100644 --- a/docs/macos_docs/crabgrab/feature/wgpu/enum.WgpuVideoFramePlaneTexture.html +++ b/docs/macos_docs/crabgrab/feature/wgpu/enum.WgpuVideoFramePlaneTexture.html @@ -1,4 +1,4 @@ -WgpuVideoFramePlaneTexture in crabgrab::feature::wgpu - Rust +WgpuVideoFramePlaneTexture in crabgrab::feature::wgpu - Rust
      pub enum WgpuVideoFramePlaneTexture {
           Rgba,
           Luminance,
      diff --git a/docs/macos_docs/crabgrab/feature/wgpu/index.html b/docs/macos_docs/crabgrab/feature/wgpu/index.html
      index 110aef09..815fd2a2 100644
      --- a/docs/macos_docs/crabgrab/feature/wgpu/index.html
      +++ b/docs/macos_docs/crabgrab/feature/wgpu/index.html
      @@ -1,4 +1,4 @@
      -crabgrab::feature::wgpu - Rust
      +crabgrab::feature::wgpu - Rust
           

      Module crabgrab::feature::wgpu

      source ·
      Expand description

      Frame -> Wgpu Texture conversion (requires wgpu feature)

      Enums§

      Traits§

      \ No newline at end of file diff --git a/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html b/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html index 1c971cb0..c68cea16 100644 --- a/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html +++ b/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html @@ -1,4 +1,4 @@ -WgpuCaptureConfigExt in crabgrab::feature::wgpu - Rust +WgpuCaptureConfigExt in crabgrab::feature::wgpu - Rust
      pub trait WgpuCaptureConfigExt: Sized {
           // Required method
           fn with_wgpu_device(
      diff --git a/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html b/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html
      index 35fbcee0..3ce1a7b6 100644
      --- a/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html
      +++ b/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html
      @@ -1,4 +1,4 @@
      -WgpuCaptureStreamExt in crabgrab::feature::wgpu - Rust
      +WgpuCaptureStreamExt in crabgrab::feature::wgpu - Rust
           
      pub trait WgpuCaptureStreamExt {
           // Required methods
           fn get_wgpu_device_wrapper(
      diff --git a/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html b/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html
      index 59c3b3da..daeaa923 100644
      --- a/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html
      +++ b/docs/macos_docs/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html
      @@ -1,4 +1,4 @@
      -WgpuVideoFrameExt in crabgrab::feature::wgpu - Rust
      +WgpuVideoFrameExt in crabgrab::feature::wgpu - Rust
           
      pub trait WgpuVideoFrameExt {
           // Required method
           fn get_wgpu_texture(
      diff --git a/docs/macos_docs/crabgrab/frame/enum.AudioBufferError.html b/docs/macos_docs/crabgrab/frame/enum.AudioBufferError.html
      index 3b1962d6..16c30ba0 100644
      --- a/docs/macos_docs/crabgrab/frame/enum.AudioBufferError.html
      +++ b/docs/macos_docs/crabgrab/frame/enum.AudioBufferError.html
      @@ -1,4 +1,4 @@
      -AudioBufferError in crabgrab::frame - Rust
      +AudioBufferError in crabgrab::frame - Rust
           
      pub enum AudioBufferError {
           UnsupportedFormat,
           InvalidChannel,
      diff --git a/docs/macos_docs/crabgrab/frame/enum.AudioChannelCount.html b/docs/macos_docs/crabgrab/frame/enum.AudioChannelCount.html
      index ccc8d3ca..45e4e291 100644
      --- a/docs/macos_docs/crabgrab/frame/enum.AudioChannelCount.html
      +++ b/docs/macos_docs/crabgrab/frame/enum.AudioChannelCount.html
      @@ -1,4 +1,4 @@
      -AudioChannelCount in crabgrab::frame - Rust
      +AudioChannelCount in crabgrab::frame - Rust
           
      pub enum AudioChannelCount {
           Mono,
           Stereo,
      diff --git a/docs/macos_docs/crabgrab/frame/enum.AudioChannelData.html b/docs/macos_docs/crabgrab/frame/enum.AudioChannelData.html
      index cf3e7827..c9d0911c 100644
      --- a/docs/macos_docs/crabgrab/frame/enum.AudioChannelData.html
      +++ b/docs/macos_docs/crabgrab/frame/enum.AudioChannelData.html
      @@ -1,4 +1,4 @@
      -AudioChannelData in crabgrab::frame - Rust
      +AudioChannelData in crabgrab::frame - Rust
           
      pub enum AudioChannelData<'data> {
           F32(AudioChannelDataSamples<'data, f32>),
           I32(AudioChannelDataSamples<'data, i32>),
      diff --git a/docs/macos_docs/crabgrab/frame/enum.AudioSampleRate.html b/docs/macos_docs/crabgrab/frame/enum.AudioSampleRate.html
      index 51cdc611..f0f67d52 100644
      --- a/docs/macos_docs/crabgrab/frame/enum.AudioSampleRate.html
      +++ b/docs/macos_docs/crabgrab/frame/enum.AudioSampleRate.html
      @@ -1,4 +1,4 @@
      -AudioSampleRate in crabgrab::frame - Rust
      +AudioSampleRate in crabgrab::frame - Rust
           
      pub enum AudioSampleRate {
           Hz8000,
           Hz16000,
      diff --git a/docs/macos_docs/crabgrab/frame/index.html b/docs/macos_docs/crabgrab/frame/index.html
      index b338fe09..ba0b7dc5 100644
      --- a/docs/macos_docs/crabgrab/frame/index.html
      +++ b/docs/macos_docs/crabgrab/frame/index.html
      @@ -1,3 +1,3 @@
      -crabgrab::frame - Rust
      +crabgrab::frame - Rust
           

      Module crabgrab::frame

      source ·
      Expand description

      Audio and video frames

      Structs§

      Enums§

      \ No newline at end of file diff --git a/docs/macos_docs/crabgrab/frame/struct.AudioChannelDataSamples.html b/docs/macos_docs/crabgrab/frame/struct.AudioChannelDataSamples.html index ffcb6b00..209338e9 100644 --- a/docs/macos_docs/crabgrab/frame/struct.AudioChannelDataSamples.html +++ b/docs/macos_docs/crabgrab/frame/struct.AudioChannelDataSamples.html @@ -1,4 +1,4 @@ -AudioChannelDataSamples in crabgrab::frame - Rust +AudioChannelDataSamples in crabgrab::frame - Rust
      pub struct AudioChannelDataSamples<'data, T> { /* private fields */ }
      Expand description

      Wraps a “slice” of audio data for one channel, handling data stride

      Implementations§

      source§

      impl<T: Copy> AudioChannelDataSamples<'_, T>

      source

      pub fn get(&self, n: usize) -> T

      Get the nth sample for this channel data

      source

      pub fn length(&self) -> usize

      Get the length of this sample buffer

      diff --git a/docs/macos_docs/crabgrab/frame/struct.AudioFrame.html b/docs/macos_docs/crabgrab/frame/struct.AudioFrame.html index 7c0b5c00..e3bb4421 100644 --- a/docs/macos_docs/crabgrab/frame/struct.AudioFrame.html +++ b/docs/macos_docs/crabgrab/frame/struct.AudioFrame.html @@ -1,4 +1,4 @@ -AudioFrame in crabgrab::frame - Rust +AudioFrame in crabgrab::frame - Rust

      Struct crabgrab::frame::AudioFrame

      source ·
      pub struct AudioFrame { /* private fields */ }
      Expand description

      A frame of captured audio

      Implementations§

      source§

      impl AudioFrame

      source

      pub fn sample_rate(&self) -> AudioSampleRate

      Get the sample rate of the captured audio

      source

      pub fn channel_count(&self) -> AudioChannelCount

      Get the channel count of the captured audio

      diff --git a/docs/macos_docs/crabgrab/frame/struct.VideoFrame.html b/docs/macos_docs/crabgrab/frame/struct.VideoFrame.html index fef05d73..d8d53028 100644 --- a/docs/macos_docs/crabgrab/frame/struct.VideoFrame.html +++ b/docs/macos_docs/crabgrab/frame/struct.VideoFrame.html @@ -1,4 +1,4 @@ -VideoFrame in crabgrab::frame - Rust +VideoFrame in crabgrab::frame - Rust

      Struct crabgrab::frame::VideoFrame

      source ·
      pub struct VideoFrame { /* private fields */ }
      Expand description

      A frame of captured video

      Implementations§

      source§

      impl VideoFrame

      source

      pub fn frame_id(&self) -> u64

      Get the sequence id of this video frame (monotonically increasing)

      Note: This is separate from audio frame ids

      diff --git a/docs/macos_docs/crabgrab/index.html b/docs/macos_docs/crabgrab/index.html index 80878982..4ab9bc80 100644 --- a/docs/macos_docs/crabgrab/index.html +++ b/docs/macos_docs/crabgrab/index.html @@ -1,4 +1,4 @@ -crabgrab - Rust 256 257 258 +259 +260 +261 +262 +263
      use std::{error::Error, fmt::{Debug, Display}};
       
       use crate::{platform::platform_impl::{ImplCapturableApplication, ImplCapturableContent, ImplCapturableDisplay, ImplCapturableWindow}, util::Rect};
      @@ -515,5 +520,10 @@ 

      Files

      pub fn identifier(&self) -> String { self.impl_capturable_application.identifier() } + + /// Gets the friendly name of the application + pub fn name(&self) -> String { + self.impl_capturable_application.name() + } }
      \ No newline at end of file diff --git a/docs/macos_docs/src/crabgrab/platform/macos/capturable_content.rs.html b/docs/macos_docs/src/crabgrab/platform/macos/capturable_content.rs.html index 68582c3e..944f273a 100644 --- a/docs/macos_docs/src/crabgrab/platform/macos/capturable_content.rs.html +++ b/docs/macos_docs/src/crabgrab/platform/macos/capturable_content.rs.html @@ -164,13 +164,31 @@

      Files

      162 163 164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182
      use std::{cell::Cell, fmt::Debug, hash::Hash};
       
       use futures::channel::oneshot;
       use libc::getpid;
       use parking_lot::Mutex;
       
      -use crate::{capturable_content::{CapturableContentFilter, CapturableContentError}, util::{Rect, Point, Size}};
      +use crate::{capturable_content::{CapturableContentError, CapturableContentFilter}, prelude::CapturableWindow, util::{Point, Rect, Size}};
       
       use super::objc_wrap::{CGMainDisplayID, SCDisplay, SCRunningApplication, SCShareableContent, SCWindow};
       
      @@ -327,5 +345,23 @@ 

      Files

      pub fn identifier(&self) -> String { self.running_application.bundle_identifier() } + + pub fn name(&self) -> String { + self.running_application.application_name() + } +} + +/// A capturable window on MacOS which allows getting the native window ID +pub trait MacosCapturableWindowNativeWindowId { + /// Get the native window id for this capturable window. + /// This is the `CGWindowID` for this window. + fn get_native_window_id(&self) -> u32; } + +impl MacosCapturableWindowNativeWindowId for CapturableWindow { + fn get_native_window_id(&self) -> u32 { + self.impl_capturable_window.window.id().0 + } +} +
      \ No newline at end of file diff --git a/docs/macos_docs/src/crabgrab/platform/macos/mod.rs.html b/docs/macos_docs/src/crabgrab/platform/macos/mod.rs.html index 2507701e..b8a12ded 100644 --- a/docs/macos_docs/src/crabgrab/platform/macos/mod.rs.html +++ b/docs/macos_docs/src/crabgrab/platform/macos/mod.rs.html @@ -23,6 +23,8 @@

      Files

      21 22 23 +24 +25
      #![allow(unused)]
       
       pub(crate) mod capture_stream;
      @@ -46,4 +48,5 @@ 

      Files

      pub use capture_stream::MacosAudioCaptureConfigExt; /// Macos-specific extensions for capture configs pub use capture_stream::MacosCaptureConfigExt; -
      \ No newline at end of file + +pub use capturable_content::MacosCapturableWindowNativeWindowId;

    \ No newline at end of file diff --git a/docs/macos_docs/trait.impl/crabgrab/platform/macos/capturable_content/trait.MacosCapturableWindowNativeWindowId.js b/docs/macos_docs/trait.impl/crabgrab/platform/macos/capturable_content/trait.MacosCapturableWindowNativeWindowId.js new file mode 100644 index 00000000..d7ba5ecd --- /dev/null +++ b/docs/macos_docs/trait.impl/crabgrab/platform/macos/capturable_content/trait.MacosCapturableWindowNativeWindowId.js @@ -0,0 +1,3 @@ +(function() {var implementors = { +"crabgrab":[] +};if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/all.html b/docs/windows_docs/crabgrab/all.html index d05f27d5..ecf53691 100644 --- a/docs/windows_docs/crabgrab/all.html +++ b/docs/windows_docs/crabgrab/all.html @@ -1,2 +1,2 @@ -List of all items in this crate -

    List of all items

    Structs

    Enums

    Traits

    Functions

    \ No newline at end of file +List of all items in this crate +

    List of all items

    Structs

    Enums

    Traits

    Functions

    \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/capturable_content/enum.CapturableContentError.html b/docs/windows_docs/crabgrab/capturable_content/enum.CapturableContentError.html index 6a6de3ce..3008c3ec 100644 --- a/docs/windows_docs/crabgrab/capturable_content/enum.CapturableContentError.html +++ b/docs/windows_docs/crabgrab/capturable_content/enum.CapturableContentError.html @@ -1,8 +1,8 @@ -CapturableContentError in crabgrab::capturable_content - Rust +CapturableContentError in crabgrab::capturable_content - Rust
    pub enum CapturableContentError {
         Other(String),
     }
    Expand description

    Represents an error that occurred when enumerating capturable content

    -

    Variants§

    §

    Other(String)

    Trait Implementations§

    source§

    impl Clone for CapturableContentError

    source§

    fn clone(&self) -> CapturableContentError

    Returns a copy of the value. Read more
    1.0.0 · source§

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

    Performs copy-assignment from source. Read more
    source§

    impl Debug for CapturableContentError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Display for CapturableContentError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Error for CapturableContentError

    source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where +

    Variants§

    §

    Other(String)

    Trait Implementations§

    source§

    impl Clone for CapturableContentError

    source§

    fn clone(&self) -> CapturableContentError

    Returns a copy of the value. Read more
    1.0.0 · source§

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

    Performs copy-assignment from source. Read more
    source§

    impl Debug for CapturableContentError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Display for CapturableContentError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Error for CapturableContentError

    source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where T: ?Sized,

    source§

    fn borrow(&self) -> &T

    Immutably borrows from an owned value. Read more
    source§

    impl<T> BorrowMut<T> for T
    where T: ?Sized,

    source§

    fn borrow_mut(&mut self) -> &mut T

    Mutably borrows from an owned value. Read more
    source§

    impl<T> From<T> for T

    source§

    fn from(t: T) -> T

    Returns the argument unchanged.

    diff --git a/docs/windows_docs/crabgrab/capturable_content/index.html b/docs/windows_docs/crabgrab/capturable_content/index.html index f0e04b15..662dd7e8 100644 --- a/docs/windows_docs/crabgrab/capturable_content/index.html +++ b/docs/windows_docs/crabgrab/capturable_content/index.html @@ -1,3 +1,3 @@ -crabgrab::capturable_content - Rust -
    Expand description

    Enumeration of capturable items

    +crabgrab::capturable_content - Rust +
    Expand description

    Enumeration of capturable items

    Structs§

    Enums§

    \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableApplication.html b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableApplication.html index f8babaf7..60fd0ab3 100644 --- a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableApplication.html +++ b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableApplication.html @@ -1,7 +1,8 @@ -CapturableApplication in crabgrab::capturable_content - Rust +CapturableApplication in crabgrab::capturable_content - Rust
    pub struct CapturableApplication { /* private fields */ }
    Expand description

    Represents an application with capturable windows

    -

    Implementations§

    source§

    impl CapturableApplication

    source

    pub fn identifier(&self) -> String

    Gets the “identifier” of the application

    +

    Implementations§

    source§

    impl CapturableApplication

    source

    pub fn identifier(&self) -> String

    Gets the “identifier” of the application

    On MacOS, this is the application bundle, and on windows, this is the application file name

    +
    source

    pub fn name(&self) -> String

    Gets the friendly name of the application

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where T: ?Sized,

    source§

    fn borrow(&self) -> &T

    Immutably borrows from an owned value. Read more
    source§

    impl<T> BorrowMut<T> for T
    where diff --git a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableContent.html b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableContent.html index c3cc1c45..26d58088 100644 --- a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableContent.html +++ b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableContent.html @@ -1,4 +1,4 @@ -CapturableContent in crabgrab::capturable_content - Rust +CapturableContent in crabgrab::capturable_content - Rust
    pub struct CapturableContent { /* private fields */ }
    Expand description

    A collection of capturable content (windows, screens)

    Implementations§

    source§

    impl CapturableContent

    source

    pub async fn new( filter: CapturableContentFilter diff --git a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html index df501f0e..6f6e6120 100644 --- a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html +++ b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html @@ -1,4 +1,4 @@ -CapturableContentFilter in crabgrab::capturable_content - Rust +CapturableContentFilter in crabgrab::capturable_content - Rust
    pub struct CapturableContentFilter {
         pub windows: Option<CapturableWindowFilter>,
         pub displays: bool,
    diff --git a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableDisplay.html b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableDisplay.html
    index 4eb60ef9..c85e4b9a 100644
    --- a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableDisplay.html
    +++ b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableDisplay.html
    @@ -1,4 +1,4 @@
    -CapturableDisplay in crabgrab::capturable_content - Rust
    +CapturableDisplay in crabgrab::capturable_content - Rust
         
    pub struct CapturableDisplay { /* private fields */ }
    Expand description

    Represents a capturable display

    Implementations§

    source§

    impl CapturableDisplay

    source

    pub fn rect(&self) -> Rect

    Gets the virtual screen rectangle of this display

    Note: Currently on windows, this is only evaluated at the time of display enumeration

    diff --git a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html index b579cf9c..5b45625f 100644 --- a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html +++ b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html @@ -1,4 +1,4 @@ -CapturableDisplayIterator in crabgrab::capturable_content - Rust +CapturableDisplayIterator in crabgrab::capturable_content - Rust
    pub struct CapturableDisplayIterator<'content> { /* private fields */ }
    Expand description

    An iterator over capturable displays

    Trait Implementations§

    source§

    impl ExactSizeIterator for CapturableDisplayIterator<'_>

    source§

    fn len(&self) -> usize

    Returns the exact remaining length of the iterator. Read more
    source§

    fn is_empty(&self) -> bool

    🔬This is a nightly-only experimental API. (exact_size_is_empty)
    Returns true if the iterator is empty. Read more
    source§

    impl Iterator for CapturableDisplayIterator<'_>

    §

    type Item = CapturableDisplay

    The type of the elements being iterated over.
    source§

    fn next(&mut self) -> Option<Self::Item>

    Advances the iterator and returns the next value. Read more
    source§

    fn size_hint(&self) -> (usize, Option<usize>)

    Returns the bounds on the remaining length of the iterator. Read more
    source§

    fn next_chunk<const N: usize>( &mut self diff --git a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindow.html b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindow.html index 935734e3..9be7c050 100644 --- a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindow.html +++ b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindow.html @@ -1,4 +1,4 @@ -CapturableWindow in crabgrab::capturable_content - Rust +CapturableWindow in crabgrab::capturable_content - Rust
    pub struct CapturableWindow { /* private fields */ }
    Expand description

    Represents a capturable application window

    Implementations§

    source§

    impl CapturableWindow

    source

    pub fn title(&self) -> String

    Gets the title of the window

    source

    pub fn rect(&self) -> Rect

    Gets the virtual screen rectangle of the window

    @@ -8,7 +8,7 @@ H: Hasher, Self: Sized,

    Feeds a slice of this type into the given Hasher. Read more
    source§

    impl PartialEq for CapturableWindow

    source§

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

    This method tests for self and other values to be equal, and is used by ==.
    1.0.0 · source§

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

    This method tests for !=. The default implementation is almost always -sufficient, and should not be overridden without very good reason.
    source§

    impl Eq for CapturableWindow

    source§

    impl Send for CapturableWindow

    source§

    impl StructuralPartialEq for CapturableWindow

    source§

    impl Sync for CapturableWindow

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where +sufficient, and should not be overridden without very good reason.

    source§

    impl WindowsCapturableWindowNativeWindowHandle for CapturableWindow

    source§

    impl Eq for CapturableWindow

    source§

    impl Send for CapturableWindow

    source§

    impl StructuralPartialEq for CapturableWindow

    source§

    impl Sync for CapturableWindow

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where T: ?Sized,

    source§

    fn borrow(&self) -> &T

    Immutably borrows from an owned value. Read more
    source§

    impl<T> BorrowMut<T> for T
    where T: ?Sized,

    source§

    fn borrow_mut(&mut self) -> &mut T

    Mutably borrows from an owned value. Read more
    §

    impl<Q, K> Equivalent<K> for Q
    where diff --git a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html index 9d457008..24543247 100644 --- a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html +++ b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html @@ -1,4 +1,4 @@ -CapturableWindowFilter in crabgrab::capturable_content - Rust +CapturableWindowFilter in crabgrab::capturable_content - Rust
    pub struct CapturableWindowFilter {
         pub desktop_windows: bool,
         pub onscreen_only: bool,
    diff --git a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html
    index 004dc69c..2dbab8dd 100644
    --- a/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html
    +++ b/docs/windows_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html
    @@ -1,4 +1,4 @@
    -CapturableWindowIterator in crabgrab::capturable_content - Rust
    +CapturableWindowIterator in crabgrab::capturable_content - Rust
         
    pub struct CapturableWindowIterator<'content> { /* private fields */ }
    Expand description

    An iterator over capturable windows

    Trait Implementations§

    source§

    impl ExactSizeIterator for CapturableWindowIterator<'_>

    1.0.0 · source§

    fn len(&self) -> usize

    Returns the exact remaining length of the iterator. Read more
    source§

    fn is_empty(&self) -> bool

    🔬This is a nightly-only experimental API. (exact_size_is_empty)
    Returns true if the iterator is empty. Read more
    source§

    impl Iterator for CapturableWindowIterator<'_>

    §

    type Item = CapturableWindow

    The type of the elements being iterated over.
    source§

    fn next(&mut self) -> Option<Self::Item>

    Advances the iterator and returns the next value. Read more
    source§

    fn size_hint(&self) -> (usize, Option<usize>)

    Returns the bounds on the remaining length of the iterator. Read more
    source§

    fn next_chunk<const N: usize>( &mut self diff --git a/docs/windows_docs/crabgrab/capture_stream/enum.CaptureConfigError.html b/docs/windows_docs/crabgrab/capture_stream/enum.CaptureConfigError.html index 17cbe51c..e7516066 100644 --- a/docs/windows_docs/crabgrab/capture_stream/enum.CaptureConfigError.html +++ b/docs/windows_docs/crabgrab/capture_stream/enum.CaptureConfigError.html @@ -1,4 +1,4 @@ -CaptureConfigError in crabgrab::capture_stream - Rust +CaptureConfigError in crabgrab::capture_stream - Rust
    pub enum CaptureConfigError {
         UnsupportedPixelFormat,
         InvalidBufferCount,
    diff --git a/docs/windows_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html b/docs/windows_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html
    index 98d92d68..a0c487f5 100644
    --- a/docs/windows_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html
    +++ b/docs/windows_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html
    @@ -1,4 +1,4 @@
    -CapturePixelFormat in crabgrab::capture_stream - Rust
    +CapturePixelFormat in crabgrab::capture_stream - Rust
         
    #[non_exhaustive]
    pub enum CapturePixelFormat { Bgra8888, Argb2101010, diff --git a/docs/windows_docs/crabgrab/capture_stream/enum.StreamCreateError.html b/docs/windows_docs/crabgrab/capture_stream/enum.StreamCreateError.html index 4dab9b21..227fe537 100644 --- a/docs/windows_docs/crabgrab/capture_stream/enum.StreamCreateError.html +++ b/docs/windows_docs/crabgrab/capture_stream/enum.StreamCreateError.html @@ -1,10 +1,10 @@ -StreamCreateError in crabgrab::capture_stream - Rust +StreamCreateError in crabgrab::capture_stream - Rust
    pub enum StreamCreateError {
         Other(String),
         UnsupportedPixelFormat,
     }
    Expand description

    This represents an error when creating a capture stream

    Variants§

    §

    Other(String)

    §

    UnsupportedPixelFormat

    The supplied pixel format is unsupported by the implementation

    -

    Trait Implementations§

    source§

    impl Clone for StreamCreateError

    source§

    fn clone(&self) -> StreamCreateError

    Returns a copy of the value. Read more
    1.0.0 · source§

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

    Performs copy-assignment from source. Read more
    source§

    impl Debug for StreamCreateError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Display for StreamCreateError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Error for StreamCreateError

    source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more
    source§

    impl Send for StreamCreateError

    source§

    impl Sync for StreamCreateError

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where +

    Trait Implementations§

    source§

    impl Clone for StreamCreateError

    source§

    fn clone(&self) -> StreamCreateError

    Returns a copy of the value. Read more
    1.0.0 · source§

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

    Performs copy-assignment from source. Read more
    source§

    impl Debug for StreamCreateError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Display for StreamCreateError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Error for StreamCreateError

    source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more
    source§

    impl Send for StreamCreateError

    source§

    impl Sync for StreamCreateError

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where T: ?Sized,

    source§

    fn borrow(&self) -> &T

    Immutably borrows from an owned value. Read more
    source§

    impl<T> BorrowMut<T> for T
    where T: ?Sized,

    source§

    fn borrow_mut(&mut self) -> &mut T

    Mutably borrows from an owned value. Read more
    source§

    impl<T> From<T> for T

    source§

    fn from(t: T) -> T

    Returns the argument unchanged.

    diff --git a/docs/windows_docs/crabgrab/capture_stream/enum.StreamError.html b/docs/windows_docs/crabgrab/capture_stream/enum.StreamError.html index c4eb55ea..062655f0 100644 --- a/docs/windows_docs/crabgrab/capture_stream/enum.StreamError.html +++ b/docs/windows_docs/crabgrab/capture_stream/enum.StreamError.html @@ -1,8 +1,8 @@ -StreamError in crabgrab::capture_stream - Rust +StreamError in crabgrab::capture_stream - Rust
    pub enum StreamError {
         Other(String),
     }
    Expand description

    This represents an error during a stream, for example a failure to retrieve a video or audio frame

    -

    Variants§

    §

    Other(String)

    Trait Implementations§

    source§

    impl Clone for StreamError

    source§

    fn clone(&self) -> StreamError

    Returns a copy of the value. Read more
    1.0.0 · source§

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

    Performs copy-assignment from source. Read more
    source§

    impl Debug for StreamError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Display for StreamError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Error for StreamError

    source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where +

    Variants§

    §

    Other(String)

    Trait Implementations§

    source§

    impl Clone for StreamError

    source§

    fn clone(&self) -> StreamError

    Returns a copy of the value. Read more
    1.0.0 · source§

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

    Performs copy-assignment from source. Read more
    source§

    impl Debug for StreamError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Display for StreamError

    source§

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

    Formats the value using the given formatter. Read more
    source§

    impl Error for StreamError

    source§

    fn source(&self) -> Option<&(dyn Error + 'static)>

    The lower-level source of this error, if any. Read more
    source§

    fn description(&self) -> &str

    👎Deprecated since 1.42.0: use the Display impl or to_string()
    source§

    fn cause(&self) -> Option<&dyn Error>

    👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
    source§

    fn provide<'a>(&'a self, request: &mut Request<'a>)

    🔬This is a nightly-only experimental API. (error_generic_member_access)
    Provides type based access to context intended for error reports. Read more

    Auto Trait Implementations§

    Blanket Implementations§

    source§

    impl<T> Any for T
    where T: 'static + ?Sized,

    source§

    fn type_id(&self) -> TypeId

    Gets the TypeId of self. Read more
    source§

    impl<T> Borrow<T> for T
    where T: ?Sized,

    source§

    fn borrow(&self) -> &T

    Immutably borrows from an owned value. Read more
    source§

    impl<T> BorrowMut<T> for T
    where T: ?Sized,

    source§

    fn borrow_mut(&mut self) -> &mut T

    Mutably borrows from an owned value. Read more
    source§

    impl<T> From<T> for T

    source§

    fn from(t: T) -> T

    Returns the argument unchanged.

    diff --git a/docs/windows_docs/crabgrab/capture_stream/enum.StreamEvent.html b/docs/windows_docs/crabgrab/capture_stream/enum.StreamEvent.html index bf65d6ef..e6a3f2f7 100644 --- a/docs/windows_docs/crabgrab/capture_stream/enum.StreamEvent.html +++ b/docs/windows_docs/crabgrab/capture_stream/enum.StreamEvent.html @@ -1,4 +1,4 @@ -StreamEvent in crabgrab::capture_stream - Rust +StreamEvent in crabgrab::capture_stream - Rust
    pub enum StreamEvent {
         Audio(AudioFrame),
         Video(VideoFrame),
    diff --git a/docs/windows_docs/crabgrab/capture_stream/enum.StreamStopError.html b/docs/windows_docs/crabgrab/capture_stream/enum.StreamStopError.html
    index c047a675..bbf529bf 100644
    --- a/docs/windows_docs/crabgrab/capture_stream/enum.StreamStopError.html
    +++ b/docs/windows_docs/crabgrab/capture_stream/enum.StreamStopError.html
    @@ -1,4 +1,4 @@
    -StreamStopError in crabgrab::capture_stream - Rust
    +StreamStopError in crabgrab::capture_stream - Rust
         
    pub enum StreamStopError {
         Other(String),
         AlreadyStopped,
    diff --git a/docs/windows_docs/crabgrab/capture_stream/index.html b/docs/windows_docs/crabgrab/capture_stream/index.html
    index a6d79139..bf8aa44b 100644
    --- a/docs/windows_docs/crabgrab/capture_stream/index.html
    +++ b/docs/windows_docs/crabgrab/capture_stream/index.html
    @@ -1,3 +1,3 @@
    -crabgrab::capture_stream - Rust
    +crabgrab::capture_stream - Rust
         
    Expand description

    The actual capture stream and related constructs

    Structs§

    Enums§

    \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html b/docs/windows_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html index da7f3dfe..8c64a443 100644 --- a/docs/windows_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html +++ b/docs/windows_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html @@ -1,4 +1,4 @@ -AudioCaptureConfig in crabgrab::capture_stream - Rust +AudioCaptureConfig in crabgrab::capture_stream - Rust
    pub struct AudioCaptureConfig { /* private fields */ }
    Expand description

    Configuration settings for audio streams

    Implementations§

    source§

    impl AudioCaptureConfig

    source

    pub fn new() -> Self

    Creates a new audio capture config with default settings:

      diff --git a/docs/windows_docs/crabgrab/capture_stream/struct.CaptureAccessToken.html b/docs/windows_docs/crabgrab/capture_stream/struct.CaptureAccessToken.html index aecc9e0e..b2234b1f 100644 --- a/docs/windows_docs/crabgrab/capture_stream/struct.CaptureAccessToken.html +++ b/docs/windows_docs/crabgrab/capture_stream/struct.CaptureAccessToken.html @@ -1,4 +1,4 @@ -CaptureAccessToken in crabgrab::capture_stream - Rust +CaptureAccessToken in crabgrab::capture_stream - Rust
      pub struct CaptureAccessToken { /* private fields */ }
      Expand description

      Represents programmatic capture access

      Implementations§

      Trait Implementations§

      source§

      impl Clone for CaptureAccessToken

      source§

      fn clone(&self) -> CaptureAccessToken

      Returns a copy of the value. Read more
      1.0.0 · source§

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

      Performs copy-assignment from source. Read more
      source§

      impl Debug for CaptureAccessToken

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Copy for CaptureAccessToken

      source§

      impl Send for CaptureAccessToken

      source§

      impl Sync for CaptureAccessToken

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where T: 'static + ?Sized,

      source§

      fn type_id(&self) -> TypeId

      Gets the TypeId of self. Read more
      source§

      impl<T> Borrow<T> for T
      where diff --git a/docs/windows_docs/crabgrab/capture_stream/struct.CaptureConfig.html b/docs/windows_docs/crabgrab/capture_stream/struct.CaptureConfig.html index 64ae5bd9..76a38041 100644 --- a/docs/windows_docs/crabgrab/capture_stream/struct.CaptureConfig.html +++ b/docs/windows_docs/crabgrab/capture_stream/struct.CaptureConfig.html @@ -1,4 +1,4 @@ -CaptureConfig in crabgrab::capture_stream - Rust +CaptureConfig in crabgrab::capture_stream - Rust
      pub struct CaptureConfig { /* private fields */ }
      Expand description

      Configuration settings for a capture stream

      Implementations§

      source§

      impl CaptureConfig

      source

      pub fn with_window( window: CapturableWindow, diff --git a/docs/windows_docs/crabgrab/capture_stream/struct.CaptureStream.html b/docs/windows_docs/crabgrab/capture_stream/struct.CaptureStream.html index 5fba9b40..2f665ec2 100644 --- a/docs/windows_docs/crabgrab/capture_stream/struct.CaptureStream.html +++ b/docs/windows_docs/crabgrab/capture_stream/struct.CaptureStream.html @@ -1,4 +1,4 @@ -CaptureStream in crabgrab::capture_stream - Rust +CaptureStream in crabgrab::capture_stream - Rust
      pub struct CaptureStream { /* private fields */ }
      Expand description

      Represents an active capture stream

      Implementations§

      source§

      impl CaptureStream

      source

      pub fn test_access(borderless: bool) -> Option<CaptureAccessToken>

      Test whether the calling application has permission to capture content

      source

      pub async fn request_access(borderless: bool) -> Option<CaptureAccessToken>

      Prompt the user for permission to capture content

      diff --git a/docs/windows_docs/crabgrab/feature/bitmap/enum.FrameBitmap.html b/docs/windows_docs/crabgrab/feature/bitmap/enum.FrameBitmap.html index f68067f0..01d48937 100644 --- a/docs/windows_docs/crabgrab/feature/bitmap/enum.FrameBitmap.html +++ b/docs/windows_docs/crabgrab/feature/bitmap/enum.FrameBitmap.html @@ -1,4 +1,4 @@ -FrameBitmap in crabgrab::feature::bitmap - Rust +FrameBitmap in crabgrab::feature::bitmap - Rust
      pub enum FrameBitmap {
           BgraUnorm8x4(FrameBitmapBgraUnorm8x4),
           RgbaUnormPacked1010102(FrameBitmapRgbaUnormPacked1010102),
      diff --git a/docs/windows_docs/crabgrab/feature/bitmap/enum.VideoFrameBitmapError.html b/docs/windows_docs/crabgrab/feature/bitmap/enum.VideoFrameBitmapError.html
      index ef200a62..bcd7d2e5 100644
      --- a/docs/windows_docs/crabgrab/feature/bitmap/enum.VideoFrameBitmapError.html
      +++ b/docs/windows_docs/crabgrab/feature/bitmap/enum.VideoFrameBitmapError.html
      @@ -1,8 +1,8 @@
      -VideoFrameBitmapError in crabgrab::feature::bitmap - Rust
      +VideoFrameBitmapError in crabgrab::feature::bitmap - Rust
           
      pub enum VideoFrameBitmapError {
           Other(String),
       }
      Expand description

      Represents an error while generating a frame bitmap

      -

      Variants§

      §

      Other(String)

      Trait Implementations§

      source§

      impl Clone for VideoFrameBitmapError

      source§

      fn clone(&self) -> VideoFrameBitmapError

      Returns a copy of the value. Read more
      1.0.0 · source§

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

      Performs copy-assignment from source. Read more
      source§

      impl Debug for VideoFrameBitmapError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for VideoFrameBitmapError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for VideoFrameBitmapError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where +

      Variants§

      §

      Other(String)

      Trait Implementations§

      source§

      impl Clone for VideoFrameBitmapError

      source§

      fn clone(&self) -> VideoFrameBitmapError

      Returns a copy of the value. Read more
      1.0.0 · source§

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

      Performs copy-assignment from source. Read more
      source§

      impl Debug for VideoFrameBitmapError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for VideoFrameBitmapError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for VideoFrameBitmapError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where T: 'static + ?Sized,

      source§

      fn type_id(&self) -> TypeId

      Gets the TypeId of self. Read more
      source§

      impl<T> Borrow<T> for T
      where T: ?Sized,

      source§

      fn borrow(&self) -> &T

      Immutably borrows from an owned value. Read more
      source§

      impl<T> BorrowMut<T> for T
      where T: ?Sized,

      source§

      fn borrow_mut(&mut self) -> &mut T

      Mutably borrows from an owned value. Read more
      source§

      impl<T> From<T> for T

      source§

      fn from(t: T) -> T

      Returns the argument unchanged.

      diff --git a/docs/windows_docs/crabgrab/feature/bitmap/enum.VideoRange.html b/docs/windows_docs/crabgrab/feature/bitmap/enum.VideoRange.html index 0bc5056e..7f97ba49 100644 --- a/docs/windows_docs/crabgrab/feature/bitmap/enum.VideoRange.html +++ b/docs/windows_docs/crabgrab/feature/bitmap/enum.VideoRange.html @@ -1,4 +1,4 @@ -VideoRange in crabgrab::feature::bitmap - Rust +VideoRange in crabgrab::feature::bitmap - Rust
      pub enum VideoRange {
           Video,
           Full,
      diff --git a/docs/windows_docs/crabgrab/feature/bitmap/index.html b/docs/windows_docs/crabgrab/feature/bitmap/index.html
      index f848fb17..fc08b649 100644
      --- a/docs/windows_docs/crabgrab/feature/bitmap/index.html
      +++ b/docs/windows_docs/crabgrab/feature/bitmap/index.html
      @@ -1,4 +1,4 @@
      -crabgrab::feature::bitmap - Rust
      +crabgrab::feature::bitmap - Rust
           

      Module crabgrab::feature::bitmap

      source ·
      Expand description

      Frame to Bitmap conversion (requires bitmap feature)

      Structs§

      Enums§

      Traits§

      \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapBgraUnorm8x4.html b/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapBgraUnorm8x4.html index 2c002ca4..bb44f5c0 100644 --- a/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapBgraUnorm8x4.html +++ b/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapBgraUnorm8x4.html @@ -1,4 +1,4 @@ -FrameBitmapBgraUnorm8x4 in crabgrab::feature::bitmap - Rust +FrameBitmapBgraUnorm8x4 in crabgrab::feature::bitmap - Rust
      pub struct FrameBitmapBgraUnorm8x4 {
           pub data: Box<[[u8; 4]]>,
           pub width: usize,
      diff --git a/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaF16x4.html b/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaF16x4.html
      index 90f01631..56fade3e 100644
      --- a/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaF16x4.html
      +++ b/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaF16x4.html
      @@ -1,4 +1,4 @@
      -FrameBitmapRgbaF16x4 in crabgrab::feature::bitmap - Rust
      +FrameBitmapRgbaF16x4 in crabgrab::feature::bitmap - Rust
           
      pub struct FrameBitmapRgbaF16x4 {
           pub data: Box<[[f16; 4]]>,
           pub width: usize,
      diff --git a/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaUnormPacked1010102.html b/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaUnormPacked1010102.html
      index ea20331b..d8afcb4d 100644
      --- a/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaUnormPacked1010102.html
      +++ b/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapRgbaUnormPacked1010102.html
      @@ -1,4 +1,4 @@
      -FrameBitmapRgbaUnormPacked1010102 in crabgrab::feature::bitmap - Rust
      +FrameBitmapRgbaUnormPacked1010102 in crabgrab::feature::bitmap - Rust
           
      pub struct FrameBitmapRgbaUnormPacked1010102 {
           pub data: Box<[u32]>,
           pub width: usize,
      diff --git a/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapYCbCr.html b/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapYCbCr.html
      index 3472fec6..23fe47a5 100644
      --- a/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapYCbCr.html
      +++ b/docs/windows_docs/crabgrab/feature/bitmap/struct.FrameBitmapYCbCr.html
      @@ -1,4 +1,4 @@
      -FrameBitmapYCbCr in crabgrab::feature::bitmap - Rust
      +FrameBitmapYCbCr in crabgrab::feature::bitmap - Rust
           
      pub struct FrameBitmapYCbCr {
           pub luma_data: Box<[u8]>,
           pub luma_width: usize,
      diff --git a/docs/windows_docs/crabgrab/feature/bitmap/trait.VideoFrameBitmap.html b/docs/windows_docs/crabgrab/feature/bitmap/trait.VideoFrameBitmap.html
      index 80010da3..1ce5e9c1 100644
      --- a/docs/windows_docs/crabgrab/feature/bitmap/trait.VideoFrameBitmap.html
      +++ b/docs/windows_docs/crabgrab/feature/bitmap/trait.VideoFrameBitmap.html
      @@ -1,4 +1,4 @@
      -VideoFrameBitmap in crabgrab::feature::bitmap - Rust
      +VideoFrameBitmap in crabgrab::feature::bitmap - Rust
           
      pub trait VideoFrameBitmap {
           // Required method
           fn get_bitmap(&self) -> Result<FrameBitmap, VideoFrameBitmapError>;
      diff --git a/docs/windows_docs/crabgrab/feature/dx11/enum.WindowsDx11VideoFrameError.html b/docs/windows_docs/crabgrab/feature/dx11/enum.WindowsDx11VideoFrameError.html
      index b6ee1704..603ec8dd 100644
      --- a/docs/windows_docs/crabgrab/feature/dx11/enum.WindowsDx11VideoFrameError.html
      +++ b/docs/windows_docs/crabgrab/feature/dx11/enum.WindowsDx11VideoFrameError.html
      @@ -1,4 +1,4 @@
      -WindowsDx11VideoFrameError in crabgrab::feature::dx11 - Rust
      +WindowsDx11VideoFrameError in crabgrab::feature::dx11 - Rust
           
      pub enum WindowsDx11VideoFrameError {
           Other(String),
       }

      Variants§

      §

      Other(String)

      Trait Implementations§

      source§

      impl Clone for WindowsDx11VideoFrameError

      source§

      fn clone(&self) -> WindowsDx11VideoFrameError

      Returns a copy of the value. Read more
      1.0.0 · source§

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

      Performs copy-assignment from source. Read more
      source§

      impl Debug for WindowsDx11VideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for WindowsDx11VideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for WindowsDx11VideoFrameError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where diff --git a/docs/windows_docs/crabgrab/feature/dx11/index.html b/docs/windows_docs/crabgrab/feature/dx11/index.html index c38d6515..be5b958d 100644 --- a/docs/windows_docs/crabgrab/feature/dx11/index.html +++ b/docs/windows_docs/crabgrab/feature/dx11/index.html @@ -1,4 +1,4 @@ -crabgrab::feature::dx11 - Rust +crabgrab::feature::dx11 - Rust

      Module crabgrab::feature::dx11

      source ·
      Expand description

      Frame -> DX11 Surface/Texture conversion (requires dx11 feature)

      Enums§

      Traits§

      \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/feature/dx11/trait.WindowsDx11CaptureStream.html b/docs/windows_docs/crabgrab/feature/dx11/trait.WindowsDx11CaptureStream.html index 90ad50d3..b4c9434d 100644 --- a/docs/windows_docs/crabgrab/feature/dx11/trait.WindowsDx11CaptureStream.html +++ b/docs/windows_docs/crabgrab/feature/dx11/trait.WindowsDx11CaptureStream.html @@ -1,4 +1,4 @@ -WindowsDx11CaptureStream in crabgrab::feature::dx11 - Rust +WindowsDx11CaptureStream in crabgrab::feature::dx11 - Rust
      pub trait WindowsDx11CaptureStream {
           // Required method
           fn get_dx11_device(&self) -> ID3D11Device;
      diff --git a/docs/windows_docs/crabgrab/feature/dx11/trait.WindowsDx11VideoFrame.html b/docs/windows_docs/crabgrab/feature/dx11/trait.WindowsDx11VideoFrame.html
      index b3d4065d..34834332 100644
      --- a/docs/windows_docs/crabgrab/feature/dx11/trait.WindowsDx11VideoFrame.html
      +++ b/docs/windows_docs/crabgrab/feature/dx11/trait.WindowsDx11VideoFrame.html
      @@ -1,4 +1,4 @@
      -WindowsDx11VideoFrame in crabgrab::feature::dx11 - Rust
      +WindowsDx11VideoFrame in crabgrab::feature::dx11 - Rust
           
      pub trait WindowsDx11VideoFrame {
           // Required methods
           fn get_dx11_surface(
      diff --git a/docs/windows_docs/crabgrab/feature/dxgi/enum.WindowsDxgiCaptureStreamError.html b/docs/windows_docs/crabgrab/feature/dxgi/enum.WindowsDxgiCaptureStreamError.html
      index ac490669..8ba5b627 100644
      --- a/docs/windows_docs/crabgrab/feature/dxgi/enum.WindowsDxgiCaptureStreamError.html
      +++ b/docs/windows_docs/crabgrab/feature/dxgi/enum.WindowsDxgiCaptureStreamError.html
      @@ -1,7 +1,7 @@
      -WindowsDxgiCaptureStreamError in crabgrab::feature::dxgi - Rust
      +WindowsDxgiCaptureStreamError in crabgrab::feature::dxgi - Rust
           
      pub enum WindowsDxgiCaptureStreamError {
           NoAdapter(String),
      -}

      Variants§

      §

      NoAdapter(String)

      Trait Implementations§

      source§

      impl Debug for WindowsDxgiCaptureStreamError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for WindowsDxgiCaptureStreamError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for WindowsDxgiCaptureStreamError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where +}

      Variants§

      §

      NoAdapter(String)

      Trait Implementations§

      source§

      impl Debug for WindowsDxgiCaptureStreamError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for WindowsDxgiCaptureStreamError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for WindowsDxgiCaptureStreamError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where T: 'static + ?Sized,

      source§

      fn type_id(&self) -> TypeId

      Gets the TypeId of self. Read more
      source§

      impl<T> Borrow<T> for T
      where T: ?Sized,

      source§

      fn borrow(&self) -> &T

      Immutably borrows from an owned value. Read more
      source§

      impl<T> BorrowMut<T> for T
      where T: ?Sized,

      source§

      fn borrow_mut(&mut self) -> &mut T

      Mutably borrows from an owned value. Read more
      source§

      impl<T> From<T> for T

      source§

      fn from(t: T) -> T

      Returns the argument unchanged.

      diff --git a/docs/windows_docs/crabgrab/feature/dxgi/enum.WindowsDxgiVideoFrameError.html b/docs/windows_docs/crabgrab/feature/dxgi/enum.WindowsDxgiVideoFrameError.html index ecd29a8d..e73a5325 100644 --- a/docs/windows_docs/crabgrab/feature/dxgi/enum.WindowsDxgiVideoFrameError.html +++ b/docs/windows_docs/crabgrab/feature/dxgi/enum.WindowsDxgiVideoFrameError.html @@ -1,7 +1,7 @@ -WindowsDxgiVideoFrameError in crabgrab::feature::dxgi - Rust +WindowsDxgiVideoFrameError in crabgrab::feature::dxgi - Rust
      pub enum WindowsDxgiVideoFrameError {
           Other(String),
      -}

      Variants§

      §

      Other(String)

      Trait Implementations§

      source§

      impl Clone for WindowsDxgiVideoFrameError

      source§

      fn clone(&self) -> WindowsDxgiVideoFrameError

      Returns a copy of the value. Read more
      1.0.0 · source§

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

      Performs copy-assignment from source. Read more
      source§

      impl Debug for WindowsDxgiVideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for WindowsDxgiVideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for WindowsDxgiVideoFrameError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where +}

      Variants§

      §

      Other(String)

      Trait Implementations§

      source§

      impl Clone for WindowsDxgiVideoFrameError

      source§

      fn clone(&self) -> WindowsDxgiVideoFrameError

      Returns a copy of the value. Read more
      1.0.0 · source§

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

      Performs copy-assignment from source. Read more
      source§

      impl Debug for WindowsDxgiVideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Display for WindowsDxgiVideoFrameError

      source§

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

      Formats the value using the given formatter. Read more
      source§

      impl Error for WindowsDxgiVideoFrameError

      source§

      fn source(&self) -> Option<&(dyn Error + 'static)>

      The lower-level source of this error, if any. Read more
      source§

      fn description(&self) -> &str

      👎Deprecated since 1.42.0: use the Display impl or to_string()
      source§

      fn cause(&self) -> Option<&dyn Error>

      👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
      source§

      fn provide<'a>(&'a self, request: &mut Request<'a>)

      🔬This is a nightly-only experimental API. (error_generic_member_access)
      Provides type based access to context intended for error reports. Read more

      Auto Trait Implementations§

      Blanket Implementations§

      source§

      impl<T> Any for T
      where T: 'static + ?Sized,

      source§

      fn type_id(&self) -> TypeId

      Gets the TypeId of self. Read more
      source§

      impl<T> Borrow<T> for T
      where T: ?Sized,

      source§

      fn borrow(&self) -> &T

      Immutably borrows from an owned value. Read more
      source§

      impl<T> BorrowMut<T> for T
      where T: ?Sized,

      source§

      fn borrow_mut(&mut self) -> &mut T

      Mutably borrows from an owned value. Read more
      source§

      impl<T> From<T> for T

      source§

      fn from(t: T) -> T

      Returns the argument unchanged.

      diff --git a/docs/windows_docs/crabgrab/feature/dxgi/index.html b/docs/windows_docs/crabgrab/feature/dxgi/index.html index c0b12e0e..e8580e87 100644 --- a/docs/windows_docs/crabgrab/feature/dxgi/index.html +++ b/docs/windows_docs/crabgrab/feature/dxgi/index.html @@ -1,4 +1,4 @@ -crabgrab::feature::dxgi - Rust +crabgrab::feature::dxgi - Rust

      Module crabgrab::feature::dxgi

      source ·
      Expand description

      Frame -> DXGI Surface conversion (requires dxgi feature)

      Enums§

      Traits§

      \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/feature/dxgi/trait.WindowsDxgiCaptureStream.html b/docs/windows_docs/crabgrab/feature/dxgi/trait.WindowsDxgiCaptureStream.html index 20fe8bc8..30f4abe2 100644 --- a/docs/windows_docs/crabgrab/feature/dxgi/trait.WindowsDxgiCaptureStream.html +++ b/docs/windows_docs/crabgrab/feature/dxgi/trait.WindowsDxgiCaptureStream.html @@ -1,4 +1,4 @@ -WindowsDxgiCaptureStream in crabgrab::feature::dxgi - Rust +WindowsDxgiCaptureStream in crabgrab::feature::dxgi - Rust
      pub trait WindowsDxgiCaptureStream {
           // Required methods
           fn get_dxgi_adapter(
      diff --git a/docs/windows_docs/crabgrab/feature/dxgi/trait.WindowsDxgiVideoFrame.html b/docs/windows_docs/crabgrab/feature/dxgi/trait.WindowsDxgiVideoFrame.html
      index de265b42..6968cc4d 100644
      --- a/docs/windows_docs/crabgrab/feature/dxgi/trait.WindowsDxgiVideoFrame.html
      +++ b/docs/windows_docs/crabgrab/feature/dxgi/trait.WindowsDxgiVideoFrame.html
      @@ -1,4 +1,4 @@
      -WindowsDxgiVideoFrame in crabgrab::feature::dxgi - Rust
      +WindowsDxgiVideoFrame in crabgrab::feature::dxgi - Rust
           
      pub trait WindowsDxgiVideoFrame {
           // Required method
           fn get_dxgi_surface(
      diff --git a/docs/windows_docs/crabgrab/feature/index.html b/docs/windows_docs/crabgrab/feature/index.html
      index 484971bf..58f2aad0 100644
      --- a/docs/windows_docs/crabgrab/feature/index.html
      +++ b/docs/windows_docs/crabgrab/feature/index.html
      @@ -1,4 +1,4 @@
      -crabgrab::feature - Rust
      +crabgrab::feature - Rust
           

      Module crabgrab::feature

      source ·
      Expand description

      Extension features

      Modules§

      • Frame to Bitmap conversion (requires bitmap feature)
      • Frame -> DX11 Surface/Texture conversion diff --git a/docs/windows_docs/crabgrab/feature/screenshot/enum.ScreenshotError.html b/docs/windows_docs/crabgrab/feature/screenshot/enum.ScreenshotError.html index 3ab8bba3..a294a1f2 100644 --- a/docs/windows_docs/crabgrab/feature/screenshot/enum.ScreenshotError.html +++ b/docs/windows_docs/crabgrab/feature/screenshot/enum.ScreenshotError.html @@ -1,4 +1,4 @@ -ScreenshotError in crabgrab::feature::screenshot - Rust +ScreenshotError in crabgrab::feature::screenshot - Rust
        pub enum ScreenshotError {
             Other(String),
         }
        Expand description

        Represents an error while taking a screenshot

        diff --git a/docs/windows_docs/crabgrab/feature/screenshot/fn.take_screenshot.html b/docs/windows_docs/crabgrab/feature/screenshot/fn.take_screenshot.html index 194ccfa3..505c8115 100644 --- a/docs/windows_docs/crabgrab/feature/screenshot/fn.take_screenshot.html +++ b/docs/windows_docs/crabgrab/feature/screenshot/fn.take_screenshot.html @@ -1,4 +1,4 @@ -take_screenshot in crabgrab::feature::screenshot - Rust +take_screenshot in crabgrab::feature::screenshot - Rust
        pub async fn take_screenshot(
             token: CaptureAccessToken,
             config: CaptureConfig
        diff --git a/docs/windows_docs/crabgrab/feature/screenshot/index.html b/docs/windows_docs/crabgrab/feature/screenshot/index.html
        index 10bedace..31a27c61 100644
        --- a/docs/windows_docs/crabgrab/feature/screenshot/index.html
        +++ b/docs/windows_docs/crabgrab/feature/screenshot/index.html
        @@ -1,4 +1,4 @@
        -crabgrab::feature::screenshot - Rust
        +crabgrab::feature::screenshot - Rust
             
        Expand description

        Screenshot utility function (requires screenshot feature)

        Enums§

        Functions§

        • Take a screenshot of the capturable content given a configuration
        \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/feature/wgpu/enum.WgpuVideoFrameError.html b/docs/windows_docs/crabgrab/feature/wgpu/enum.WgpuVideoFrameError.html index 998fda93..c09af2af 100644 --- a/docs/windows_docs/crabgrab/feature/wgpu/enum.WgpuVideoFrameError.html +++ b/docs/windows_docs/crabgrab/feature/wgpu/enum.WgpuVideoFrameError.html @@ -1,4 +1,4 @@ -WgpuVideoFrameError in crabgrab::feature::wgpu - Rust +WgpuVideoFrameError in crabgrab::feature::wgpu - Rust
        pub enum WgpuVideoFrameError {
             NoBackendTexture,
             InvalidVideoPlaneTexture,
        @@ -8,7 +8,7 @@
         

        Variants§

        §

        NoBackendTexture

        the backend texture couldn’t be fetched

        §

        InvalidVideoPlaneTexture

        The requested plane isn’t valid for this frame

        §

        NoWgpuDevice

        No Wgpu device was supplied to the capture stream

        -
        §

        Other(String)

        Trait Implementations§

        source§

        impl Clone for WgpuVideoFrameError

        source§

        fn clone(&self) -> WgpuVideoFrameError

        Returns a copy of the value. Read more
        1.0.0 · source§

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

        Performs copy-assignment from source. Read more
        source§

        impl Debug for WgpuVideoFrameError

        source§

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

        Formats the value using the given formatter. Read more
        source§

        impl Display for WgpuVideoFrameError

        source§

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

        Formats the value using the given formatter. Read more
        source§

        impl Error for WgpuVideoFrameError

        source§

        fn source(&self) -> Option<&(dyn Error + 'static)>

        The lower-level source of this error, if any. Read more
        source§

        fn description(&self) -> &str

        👎Deprecated since 1.42.0: use the Display impl or to_string()
        source§

        fn cause(&self) -> Option<&dyn Error>

        👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
        source§

        fn provide<'a>(&'a self, request: &mut Request<'a>)

        🔬This is a nightly-only experimental API. (error_generic_member_access)
        Provides type based access to context intended for error reports. Read more

        Auto Trait Implementations§

        Blanket Implementations§

        source§

        impl<T> Any for T
        where +
        §

        Other(String)

        Trait Implementations§

        source§

        impl Clone for WgpuVideoFrameError

        source§

        fn clone(&self) -> WgpuVideoFrameError

        Returns a copy of the value. Read more
        1.0.0 · source§

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

        Performs copy-assignment from source. Read more
        source§

        impl Debug for WgpuVideoFrameError

        source§

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

        Formats the value using the given formatter. Read more
        source§

        impl Display for WgpuVideoFrameError

        source§

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

        Formats the value using the given formatter. Read more
        source§

        impl Error for WgpuVideoFrameError

        source§

        fn source(&self) -> Option<&(dyn Error + 'static)>

        The lower-level source of this error, if any. Read more
        source§

        fn description(&self) -> &str

        👎Deprecated since 1.42.0: use the Display impl or to_string()
        source§

        fn cause(&self) -> Option<&dyn Error>

        👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
        source§

        fn provide<'a>(&'a self, request: &mut Request<'a>)

        🔬This is a nightly-only experimental API. (error_generic_member_access)
        Provides type based access to context intended for error reports. Read more

        Auto Trait Implementations§

        Blanket Implementations§

        source§

        impl<T> Any for T
        where T: 'static + ?Sized,

        source§

        fn type_id(&self) -> TypeId

        Gets the TypeId of self. Read more
        source§

        impl<T> Borrow<T> for T
        where T: ?Sized,

        source§

        fn borrow(&self) -> &T

        Immutably borrows from an owned value. Read more
        source§

        impl<T> BorrowMut<T> for T
        where T: ?Sized,

        source§

        fn borrow_mut(&mut self) -> &mut T

        Mutably borrows from an owned value. Read more
        source§

        impl<T> From<T> for T

        source§

        fn from(t: T) -> T

        Returns the argument unchanged.

        diff --git a/docs/windows_docs/crabgrab/feature/wgpu/enum.WgpuVideoFramePlaneTexture.html b/docs/windows_docs/crabgrab/feature/wgpu/enum.WgpuVideoFramePlaneTexture.html index 7a501581..773052f5 100644 --- a/docs/windows_docs/crabgrab/feature/wgpu/enum.WgpuVideoFramePlaneTexture.html +++ b/docs/windows_docs/crabgrab/feature/wgpu/enum.WgpuVideoFramePlaneTexture.html @@ -1,4 +1,4 @@ -WgpuVideoFramePlaneTexture in crabgrab::feature::wgpu - Rust +WgpuVideoFramePlaneTexture in crabgrab::feature::wgpu - Rust
        pub enum WgpuVideoFramePlaneTexture {
             Rgba,
             Luminance,
        diff --git a/docs/windows_docs/crabgrab/feature/wgpu/index.html b/docs/windows_docs/crabgrab/feature/wgpu/index.html
        index 0a435bac..220412ab 100644
        --- a/docs/windows_docs/crabgrab/feature/wgpu/index.html
        +++ b/docs/windows_docs/crabgrab/feature/wgpu/index.html
        @@ -1,4 +1,4 @@
        -crabgrab::feature::wgpu - Rust
        +crabgrab::feature::wgpu - Rust
             

        Module crabgrab::feature::wgpu

        source ·
        Expand description

        Frame -> Wgpu Texture conversion (requires wgpu feature)

        Enums§

        Traits§

        \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html b/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html index 028823e9..f42697d5 100644 --- a/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html +++ b/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html @@ -1,4 +1,4 @@ -WgpuCaptureConfigExt in crabgrab::feature::wgpu - Rust +WgpuCaptureConfigExt in crabgrab::feature::wgpu - Rust
        pub trait WgpuCaptureConfigExt: Sized {
             // Required method
             fn with_wgpu_device(
        diff --git a/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html b/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html
        index fff5f0d0..6b3dc3c0 100644
        --- a/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html
        +++ b/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html
        @@ -1,4 +1,4 @@
        -WgpuCaptureStreamExt in crabgrab::feature::wgpu - Rust
        +WgpuCaptureStreamExt in crabgrab::feature::wgpu - Rust
             
        pub trait WgpuCaptureStreamExt {
             // Required methods
             fn get_wgpu_device_wrapper(
        diff --git a/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html b/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html
        index 9ecf838f..8a736125 100644
        --- a/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html
        +++ b/docs/windows_docs/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html
        @@ -1,4 +1,4 @@
        -WgpuVideoFrameExt in crabgrab::feature::wgpu - Rust
        +WgpuVideoFrameExt in crabgrab::feature::wgpu - Rust
             
        pub trait WgpuVideoFrameExt {
             // Required method
             fn get_wgpu_texture(
        diff --git a/docs/windows_docs/crabgrab/frame/enum.AudioBufferError.html b/docs/windows_docs/crabgrab/frame/enum.AudioBufferError.html
        index ac45d35d..ccd21f98 100644
        --- a/docs/windows_docs/crabgrab/frame/enum.AudioBufferError.html
        +++ b/docs/windows_docs/crabgrab/frame/enum.AudioBufferError.html
        @@ -1,4 +1,4 @@
        -AudioBufferError in crabgrab::frame - Rust
        +AudioBufferError in crabgrab::frame - Rust
             
        pub enum AudioBufferError {
             UnsupportedFormat,
             InvalidChannel,
        diff --git a/docs/windows_docs/crabgrab/frame/enum.AudioChannelCount.html b/docs/windows_docs/crabgrab/frame/enum.AudioChannelCount.html
        index c1472cce..adf5d4b8 100644
        --- a/docs/windows_docs/crabgrab/frame/enum.AudioChannelCount.html
        +++ b/docs/windows_docs/crabgrab/frame/enum.AudioChannelCount.html
        @@ -1,4 +1,4 @@
        -AudioChannelCount in crabgrab::frame - Rust
        +AudioChannelCount in crabgrab::frame - Rust
             
        pub enum AudioChannelCount {
             Mono,
             Stereo,
        diff --git a/docs/windows_docs/crabgrab/frame/enum.AudioChannelData.html b/docs/windows_docs/crabgrab/frame/enum.AudioChannelData.html
        index 5bafdba7..4c4903a7 100644
        --- a/docs/windows_docs/crabgrab/frame/enum.AudioChannelData.html
        +++ b/docs/windows_docs/crabgrab/frame/enum.AudioChannelData.html
        @@ -1,4 +1,4 @@
        -AudioChannelData in crabgrab::frame - Rust
        +AudioChannelData in crabgrab::frame - Rust
             
        pub enum AudioChannelData<'data> {
             F32(AudioChannelDataSamples<'data, f32>),
             I32(AudioChannelDataSamples<'data, i32>),
        diff --git a/docs/windows_docs/crabgrab/frame/enum.AudioSampleRate.html b/docs/windows_docs/crabgrab/frame/enum.AudioSampleRate.html
        index c2aa5c96..32c01ab4 100644
        --- a/docs/windows_docs/crabgrab/frame/enum.AudioSampleRate.html
        +++ b/docs/windows_docs/crabgrab/frame/enum.AudioSampleRate.html
        @@ -1,4 +1,4 @@
        -AudioSampleRate in crabgrab::frame - Rust
        +AudioSampleRate in crabgrab::frame - Rust
             
        pub enum AudioSampleRate {
             Hz8000,
             Hz16000,
        diff --git a/docs/windows_docs/crabgrab/frame/index.html b/docs/windows_docs/crabgrab/frame/index.html
        index 2998ca6c..ce6d82b1 100644
        --- a/docs/windows_docs/crabgrab/frame/index.html
        +++ b/docs/windows_docs/crabgrab/frame/index.html
        @@ -1,3 +1,3 @@
        -crabgrab::frame - Rust
        +crabgrab::frame - Rust
             

        Module crabgrab::frame

        source ·
        Expand description

        Audio and video frames

        Structs§

        Enums§

        \ No newline at end of file diff --git a/docs/windows_docs/crabgrab/frame/struct.AudioChannelDataSamples.html b/docs/windows_docs/crabgrab/frame/struct.AudioChannelDataSamples.html index b3ea1968..2cee485d 100644 --- a/docs/windows_docs/crabgrab/frame/struct.AudioChannelDataSamples.html +++ b/docs/windows_docs/crabgrab/frame/struct.AudioChannelDataSamples.html @@ -1,4 +1,4 @@ -AudioChannelDataSamples in crabgrab::frame - Rust +AudioChannelDataSamples in crabgrab::frame - Rust
        pub struct AudioChannelDataSamples<'data, T> { /* private fields */ }
        Expand description

        Wraps a “slice” of audio data for one channel, handling data stride

        Implementations§

        source§

        impl<T: Copy> AudioChannelDataSamples<'_, T>

        source

        pub fn get(&self, n: usize) -> T

        Get the nth sample for this channel data

        source

        pub fn length(&self) -> usize

        Get the length of this sample buffer

        diff --git a/docs/windows_docs/crabgrab/frame/struct.AudioFrame.html b/docs/windows_docs/crabgrab/frame/struct.AudioFrame.html index 3d6e5866..95fad7f3 100644 --- a/docs/windows_docs/crabgrab/frame/struct.AudioFrame.html +++ b/docs/windows_docs/crabgrab/frame/struct.AudioFrame.html @@ -1,4 +1,4 @@ -AudioFrame in crabgrab::frame - Rust +AudioFrame in crabgrab::frame - Rust

        Struct crabgrab::frame::AudioFrame

        source ·
        pub struct AudioFrame { /* private fields */ }
        Expand description

        A frame of captured audio

        Implementations§

        source§

        impl AudioFrame

        source

        pub fn sample_rate(&self) -> AudioSampleRate

        Get the sample rate of the captured audio

        source

        pub fn channel_count(&self) -> AudioChannelCount

        Get the channel count of the captured audio

        diff --git a/docs/windows_docs/crabgrab/frame/struct.VideoFrame.html b/docs/windows_docs/crabgrab/frame/struct.VideoFrame.html index c2b75059..72274e87 100644 --- a/docs/windows_docs/crabgrab/frame/struct.VideoFrame.html +++ b/docs/windows_docs/crabgrab/frame/struct.VideoFrame.html @@ -1,4 +1,4 @@ -VideoFrame in crabgrab::frame - Rust +VideoFrame in crabgrab::frame - Rust

        Struct crabgrab::frame::VideoFrame

        source ·
        pub struct VideoFrame { /* private fields */ }
        Expand description

        A frame of captured video

        Implementations§

        source§

        impl VideoFrame

        source

        pub fn frame_id(&self) -> u64

        Get the sequence id of this video frame (monotonically increasing)

        Note: This is separate from audio frame ids

        diff --git a/docs/windows_docs/crabgrab/index.html b/docs/windows_docs/crabgrab/index.html index 2c559fd9..bcf4959f 100644 --- a/docs/windows_docs/crabgrab/index.html +++ b/docs/windows_docs/crabgrab/index.html @@ -1,4 +1,4 @@ -crabgrab - Rust 256 257 258 +259 +260 +261 +262 +263
        use std::{error::Error, fmt::{Debug, Display}};
         
         use crate::{platform::platform_impl::{ImplCapturableApplication, ImplCapturableContent, ImplCapturableDisplay, ImplCapturableWindow}, util::Rect};
        @@ -515,5 +520,10 @@ 

        Files

        pub fn identifier(&self) -> String { self.impl_capturable_application.identifier() } + + /// Gets the friendly name of the application + pub fn name(&self) -> String { + self.impl_capturable_application.name() + } }
        \ No newline at end of file diff --git a/docs/windows_docs/src/crabgrab/platform/windows/capturable_content.rs.html b/docs/windows_docs/src/crabgrab/platform/windows/capturable_content.rs.html index 15d7310a..aad6637a 100644 --- a/docs/windows_docs/src/crabgrab/platform/windows/capturable_content.rs.html +++ b/docs/windows_docs/src/crabgrab/platform/windows/capturable_content.rs.html @@ -213,11 +213,31 @@

        Files

        211 212 213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231
        use std::{ffi::OsString, os::{raw::c_void, windows::ffi::OsStringExt}, hash::Hash};
         
        -use windows::Win32::{Foundation::{BOOL, FALSE, HANDLE, HWND, LPARAM, RECT, TRUE}, Graphics::Gdi::{EnumDisplayMonitors, GetMonitorInfoA, HDC, HMONITOR, MONITORINFO}, System::{ProcessStatus::GetModuleFileNameExW, Threading::{GetProcessId, OpenProcess, PROCESS_QUERY_INFORMATION, PROCESS_QUERY_LIMITED_INFORMATION, PROCESS_VM_READ}}, UI::WindowsAndMessaging::{EnumWindows, GetWindowDisplayAffinity, GetWindowRect, GetWindowTextA, GetWindowTextLengthA, GetWindowThreadProcessId, IsWindow, IsWindowVisible, WDA_EXCLUDEFROMCAPTURE}};
        +use windows::Win32::{Foundation::{BOOL, FALSE, HANDLE, LPARAM, RECT, TRUE}, Graphics::Gdi::{EnumDisplayMonitors, GetMonitorInfoA, HDC, HMONITOR, MONITORINFO}, System::{ProcessStatus::GetModuleFileNameExW, Threading::{GetProcessId, OpenProcess, PROCESS_QUERY_INFORMATION, PROCESS_QUERY_LIMITED_INFORMATION, PROCESS_VM_READ}}, UI::WindowsAndMessaging::{EnumWindows, GetWindowDisplayAffinity, GetWindowRect, GetWindowTextA, GetWindowTextLengthA, GetWindowThreadProcessId, IsWindow, IsWindowVisible, WDA_EXCLUDEFROMCAPTURE}};
         
        -use crate::{prelude::{CapturableContentError, CapturableContentFilter}, util::{Point, Rect, Size}};
        +pub use windows::Win32::Foundation::HWND;
        +
        +use crate::{prelude::{CapturableContentError, CapturableContentFilter, CapturableWindow}, util::{Point, Rect, Size}};
         
         use super::AutoHandle;
         
        @@ -373,6 +393,10 @@ 

        Files

        result.unwrap_or("".into()) } } + + pub fn name(&self) -> String { + self.identifier() + } } pub struct WindowsCapturableContent { @@ -425,4 +449,17 @@

        Files

        displays, }) } -}
      \ No newline at end of file +} + +/// A capturable window on Windows which provides a native window handle. This is the `HWND` for the window. +pub trait WindowsCapturableWindowNativeWindowHandle { + // Get the HWND for this capturable window. + fn get_native_window_handle(&self) -> HWND; +} + +impl WindowsCapturableWindowNativeWindowHandle for CapturableWindow { + fn get_native_window_handle(&self) -> HWND { + self.impl_capturable_window.0 + } +} +

      \ No newline at end of file diff --git a/docs/windows_docs/src/crabgrab/platform/windows/mod.rs.html b/docs/windows_docs/src/crabgrab/platform/windows/mod.rs.html index 17f86a9c..fc085f33 100644 --- a/docs/windows_docs/src/crabgrab/platform/windows/mod.rs.html +++ b/docs/windows_docs/src/crabgrab/platform/windows/mod.rs.html @@ -28,6 +28,10 @@

      Files

      26 27 28 +29 +30 +31 +32
      use windows::Win32::Foundation::CloseHandle;
       use windows::Win32::Foundation::HANDLE;
       
      @@ -56,4 +60,8 @@ 

      Files

      pub(crate) use frame::WindowsVideoFrame as ImplVideoFrame; pub(crate) use frame::WindowsAudioFrame as ImplAudioFrame; + +pub use capturable_content::WindowsCapturableWindowNativeWindowHandle; +/// Re-exported from the `windows` crate +pub use capturable_content::HWND;
      \ No newline at end of file diff --git a/docs/windows_docs/trait.impl/crabgrab/platform/windows/capturable_content/trait.WindowsCapturableWindowNativeWindowHandle.js b/docs/windows_docs/trait.impl/crabgrab/platform/windows/capturable_content/trait.WindowsCapturableWindowNativeWindowHandle.js new file mode 100644 index 00000000..d7ba5ecd --- /dev/null +++ b/docs/windows_docs/trait.impl/crabgrab/platform/windows/capturable_content/trait.WindowsCapturableWindowNativeWindowHandle.js @@ -0,0 +1,3 @@ +(function() {var implementors = { +"crabgrab":[] +};if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})() \ No newline at end of file diff --git a/src/capturable_content.rs b/src/capturable_content.rs index a2ff0694..f2634580 100644 --- a/src/capturable_content.rs +++ b/src/capturable_content.rs @@ -255,4 +255,9 @@ impl CapturableApplication { pub fn identifier(&self) -> String { self.impl_capturable_application.identifier() } + + /// Gets the friendly name of the application + pub fn name(&self) -> String { + self.impl_capturable_application.name() + } } diff --git a/src/platform/macos/capturable_content.rs b/src/platform/macos/capturable_content.rs index 4989459d..22f7f764 100644 --- a/src/platform/macos/capturable_content.rs +++ b/src/platform/macos/capturable_content.rs @@ -4,7 +4,7 @@ use futures::channel::oneshot; use libc::getpid; use parking_lot::Mutex; -use crate::{capturable_content::{CapturableContentFilter, CapturableContentError}, util::{Rect, Point, Size}}; +use crate::{capturable_content::{CapturableContentError, CapturableContentFilter}, prelude::CapturableWindow, util::{Point, Rect, Size}}; use super::objc_wrap::{CGMainDisplayID, SCDisplay, SCRunningApplication, SCShareableContent, SCWindow}; @@ -161,4 +161,22 @@ impl MacosCapturableApplication { pub fn identifier(&self) -> String { self.running_application.bundle_identifier() } + + pub fn name(&self) -> String { + self.running_application.application_name() + } +} + +/// A capturable window on MacOS which allows getting the native window ID +pub trait MacosCapturableWindowNativeWindowId { + /// Get the native window id for this capturable window. + /// This is the `CGWindowID` for this window. + fn get_native_window_id(&self) -> u32; } + +impl MacosCapturableWindowNativeWindowId for CapturableWindow { + fn get_native_window_id(&self) -> u32 { + self.impl_capturable_window.window.id().0 + } +} + diff --git a/src/platform/macos/mod.rs b/src/platform/macos/mod.rs index 95721d2e..6d23cb69 100644 --- a/src/platform/macos/mod.rs +++ b/src/platform/macos/mod.rs @@ -21,3 +21,5 @@ pub(crate) use capture_stream::MacosCaptureAccessToken as ImplCaptureAccessToken pub use capture_stream::MacosAudioCaptureConfigExt; /// Macos-specific extensions for capture configs pub use capture_stream::MacosCaptureConfigExt; + +pub use capturable_content::MacosCapturableWindowNativeWindowId; \ No newline at end of file diff --git a/src/platform/windows/capturable_content.rs b/src/platform/windows/capturable_content.rs index 847c3cb1..bdb8f369 100644 --- a/src/platform/windows/capturable_content.rs +++ b/src/platform/windows/capturable_content.rs @@ -1,8 +1,10 @@ use std::{ffi::OsString, os::{raw::c_void, windows::ffi::OsStringExt}, hash::Hash}; -use windows::Win32::{Foundation::{BOOL, FALSE, HANDLE, HWND, LPARAM, RECT, TRUE}, Graphics::Gdi::{EnumDisplayMonitors, GetMonitorInfoA, HDC, HMONITOR, MONITORINFO}, System::{ProcessStatus::GetModuleFileNameExW, Threading::{GetProcessId, OpenProcess, PROCESS_QUERY_INFORMATION, PROCESS_QUERY_LIMITED_INFORMATION, PROCESS_VM_READ}}, UI::WindowsAndMessaging::{EnumWindows, GetWindowDisplayAffinity, GetWindowRect, GetWindowTextA, GetWindowTextLengthA, GetWindowThreadProcessId, IsWindow, IsWindowVisible, WDA_EXCLUDEFROMCAPTURE}}; +use windows::Win32::{Foundation::{BOOL, FALSE, HANDLE, LPARAM, RECT, TRUE}, Graphics::Gdi::{EnumDisplayMonitors, GetMonitorInfoA, HDC, HMONITOR, MONITORINFO}, System::{ProcessStatus::GetModuleFileNameExW, Threading::{GetProcessId, OpenProcess, PROCESS_QUERY_INFORMATION, PROCESS_QUERY_LIMITED_INFORMATION, PROCESS_VM_READ}}, UI::WindowsAndMessaging::{EnumWindows, GetWindowDisplayAffinity, GetWindowRect, GetWindowTextA, GetWindowTextLengthA, GetWindowThreadProcessId, IsWindow, IsWindowVisible, WDA_EXCLUDEFROMCAPTURE}}; -use crate::{prelude::{CapturableContentError, CapturableContentFilter}, util::{Point, Rect, Size}}; +pub use windows::Win32::Foundation::HWND; + +use crate::{prelude::{CapturableContentError, CapturableContentFilter, CapturableWindow}, util::{Point, Rect, Size}}; use super::AutoHandle; @@ -158,6 +160,10 @@ impl WindowsCapturableApplication { result.unwrap_or("".into()) } } + + pub fn name(&self) -> String { + self.identifier() + } } pub struct WindowsCapturableContent { @@ -210,4 +216,16 @@ impl WindowsCapturableContent { displays, }) } -} \ No newline at end of file +} + +/// A capturable window on Windows which provides a native window handle. This is the `HWND` for the window. +pub trait WindowsCapturableWindowNativeWindowHandle { + // Get the HWND for this capturable window. + fn get_native_window_handle(&self) -> HWND; +} + +impl WindowsCapturableWindowNativeWindowHandle for CapturableWindow { + fn get_native_window_handle(&self) -> HWND { + self.impl_capturable_window.0 + } +} diff --git a/src/platform/windows/mod.rs b/src/platform/windows/mod.rs index dfbaefcc..bf3470ff 100644 --- a/src/platform/windows/mod.rs +++ b/src/platform/windows/mod.rs @@ -26,3 +26,7 @@ pub(crate) use capture_stream::WindowsCaptureAccessToken as ImplCaptureAccessTok pub(crate) use frame::WindowsVideoFrame as ImplVideoFrame; pub(crate) use frame::WindowsAudioFrame as ImplAudioFrame; + +pub use capturable_content::WindowsCapturableWindowNativeWindowHandle; +/// Re-exported from the `windows` crate +pub use capturable_content::HWND;