Struct IOSurface 

pub struct IOSurface(/* private fields */);

Wrapper around IOSurface

IOSurface is a framebuffer object suitable for sharing across process boundaries. ScreenCaptureKit uses IOSurface-backed CVPixelBuffers for efficient frame delivery.

Implementations

impl IOSurface

pub fn width(&self) -> usize

Get the width of the IOSurface in pixels

pub fn height(&self) -> usize

Get the height of the IOSurface in pixels

pub fn bytes_per_row(&self) -> usize

Get the number of bytes per row

pub fn pixel_format(&self) -> u32

Get the pixel format (OSType/FourCC)

pub unsafe fn base_address(&self) -> *mut u8

Get the base address of the IOSurface buffer

Important: You must lock the IOSurface before accessing memory!

Safety

The returned pointer is only valid while the IOSurface is locked. Accessing unlocked memory or after unlock is undefined behavior.

pub fn lock( &self, options: IOSurfaceLockOptions, ) -> Result<IOSurfaceLockGuard<'_>, i32>

Lock the IOSurface and get a guard for safe access

The surface will be automatically unlocked when the guard is dropped.

Errors

Returns an IOSurface error code if the lock operation fails.

Example

let guard = surface.lock(IOSurfaceLockOptions::ReadOnly)?;
let data = guard.as_slice();
// Use data...
// Surface is automatically unlocked when guard goes out of scope

pub fn is_in_use(&self) -> bool

Check if the IOSurface is currently in use

Trait Implementations

impl Debug for IOSurface

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

Formats the value using the given formatter.

impl Drop for IOSurface

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for IOSurface

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 PartialEq for IOSurface

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 Eq for IOSurface

impl Send for IOSurface

impl Sync for IOSurface