Struct CGDisplayStreamUpdate 

pub struct CGDisplayStreamUpdate { /* private fields */ }

Available on crate feature CGDisplayStream only.

An opaque reference to a single frame’s extra metadata that describes useful frame delta information

A CGDisplayStreamUpdate encapsulates information about what portions of a frame have changed relative to a previously delivered frame. This includes regions that were changed in any way, which ones were actually redrawn, and which regions were merely copied from one place to another. A routine is provided to merge two update refs together in cases where apps need to coalesce the values because they decided to skip processing for one or more frames.

See also Apple’s documentation

Implementations

impl CGDisplayStreamUpdate

pub unsafe fn rects( update_ref: Option<&CGDisplayStreamUpdate>, rect_type: CGDisplayStreamUpdateRectType, rect_count: NonNull<usize>, ) -> *const CGRect

👎Deprecated: Please use ScreenCaptureKit instead.

Returns a pointer to an array of CGRect structs that describe what parts of the frame have changed relative to the previously delivered frame. This rectangle list encapsulates both the update rectangles and movement rectangles.

Parameter updateRef: The CGDisplayStreamUpdateRef

Parameter rectCount: A pointer to where the count of the number of rectangles in the array is to be returned. Must not be NULL.

Returns: A pointer to the array of CGRectangles. This array should not be freed by the caller.

Safety

rect_count must be a valid pointer.

pub fn new_merged_update( first_update: Option<&CGDisplayStreamUpdate>, second_update: Option<&CGDisplayStreamUpdate>, ) -> Option<CFRetained<CGDisplayStreamUpdate>>

👎Deprecated: Please use ScreenCaptureKit instead.

Merge two CGDisplayUpdateRefs into a new one.

In cases where the client wishes to drop certain frame updates, this function may be used to merge two CGDisplayUpdateRefs together. The core bit of functionality here is generating a new set of refresh/move/dirty rectangle arrays that properly represent the union of the deltas between the two frames. Note that the ordering of the two refs is important.

Parameter firstUpdate: The first update (in a temporal sense)

Parameter secondUpdate: The second update (in a temporal sense)

Returns: The new CGDisplayStreamUpdateRef

pub unsafe fn moved_rects_delta( update_ref: Option<&CGDisplayStreamUpdate>, dx: NonNull<CGFloat>, dy: NonNull<CGFloat>, )

👎Deprecated: Please use ScreenCaptureKit instead.

Return the movement dx and dy values for a single update

Parameter updateRef: The CGDisplayStreamUpdateRef

Parameter dx: A pointer to a CGFloat to store the x component of the movement delta

Parameter dy: A pointer to a CGFloat to store the y component of the movement delta

The delta values describe the offset from the moved rectangles back to the source location.

Safety

• dx must be a valid pointer.
• dy must be a valid pointer.

pub fn drop_count(update_ref: Option<&CGDisplayStreamUpdate>) -> usize

👎Deprecated: Please use ScreenCaptureKit instead.

Return how many frames (if any) have been dropped since the last call to the handler.

Parameter updateRef: The CGDisplayStreamUpdateRef

Returns: The number of dropped frames

This call is primarily useful for performance measurement to determine if the client is keeping up with all WindowServer updates.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for CGDisplayStreamUpdate

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CFType> for CGDisplayStreamUpdate

fn as_ref(&self) -> &CFType

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CGDisplayStreamUpdate> for CGDisplayStreamUpdate

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for CGDisplayStreamUpdate

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for CGDisplayStreamUpdate

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CGDisplayStreamUpdate

fn type_id() -> CFTypeID

Returns the CF “class” ID for CGDisplayStreamUpdate

Returns: The CFTypeID of the CGDisplayStreamUpdate class.

impl Debug for CGDisplayStreamUpdate

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

Formats the value using the given formatter.

impl Deref for CGDisplayStreamUpdate

type Target = CFType

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for CGDisplayStreamUpdate

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for CGDisplayStreamUpdate

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CGDisplayStreamUpdate

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for CGDisplayStreamUpdate

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Type for CGDisplayStreamUpdate

fn retain(&self) -> CFRetained<Self>

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for CGDisplayStreamUpdate