Struct IOSurfaceLockOptions 

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

Lock options for IOSurface

This is a bitmask type that supports combining multiple options using the | operator.

Examples

use screencapturekit::cm::IOSurfaceLockOptions;

// Single option
let read_only = IOSurfaceLockOptions::READ_ONLY;

// Combined options
let combined = IOSurfaceLockOptions::READ_ONLY | IOSurfaceLockOptions::AVOID_SYNC;
assert!(combined.contains(IOSurfaceLockOptions::READ_ONLY));
assert!(combined.contains(IOSurfaceLockOptions::AVOID_SYNC));

Implementations

impl IOSurfaceLockOptions

pub const NONE: Self

No special options (read-write lock with sync)

pub const READ_ONLY: Self

Read-only lock - use when you only need to read data. This allows the system to keep caches valid.

pub const AVOID_SYNC: Self

Avoid synchronization - use with caution. Skip waiting for pending operations before completing the lock.

pub const fn from_bits(bits: u32) -> Self

Create from a raw u32 value

pub const fn as_u32(self) -> u32

Convert to u32 for FFI

pub const fn contains(self, other: Self) -> bool

Check if these options contain the given option

pub const fn is_read_only(self) -> bool

Check if this is a read-only lock

pub const fn is_avoid_sync(self) -> bool

Check if this avoids synchronization

pub const fn is_empty(self) -> bool

Check if no options are set

Trait Implementations

impl BitAnd for IOSurfaceLockOptions

type Output = IOSurfaceLockOptions

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for IOSurfaceLockOptions

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for IOSurfaceLockOptions

type Output = IOSurfaceLockOptions

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for IOSurfaceLockOptions

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for IOSurfaceLockOptions

fn clone(&self) -> IOSurfaceLockOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IOSurfaceLockOptions

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

Formats the value using the given formatter.

impl Default for IOSurfaceLockOptions

fn default() -> IOSurfaceLockOptions

Returns the “default value” for a type.

impl From<IOSurfaceLockOptions> for u32

fn from(options: IOSurfaceLockOptions) -> Self

Converts to this type from the input type.

impl Hash for IOSurfaceLockOptions

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 IOSurfaceLockOptions

fn eq(&self, other: &IOSurfaceLockOptions) -> 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 Copy for IOSurfaceLockOptions

impl Eq for IOSurfaceLockOptions

impl StructuralPartialEq for IOSurfaceLockOptions