Enum PixelFormat 

#[non_exhaustive]
pub enum PixelFormat {
    BGRA,
    l10r,
    YCbCr_420v,
    YCbCr_420f,
    xf44,
    RGhA,
    Unknown(FourCharCode),
}

Pixel format for captured video frames

Specifies the layout and encoding of pixel data in captured frames.

This enum is #[non_exhaustive]. Apple may add new pixel formats in future macOS releases; downstream code that exhaustively matches on PixelFormat must include a wildcard arm. Pixel formats this crate does not yet recognise are surfaced via the PixelFormat::Unknown variant rather than being silently coerced to PixelFormat::BGRA (which would mislead callers that branch on the format).

Equality and hashing

PixelFormat compares and hashes by its underlying FourCharCode rather than by enum variant. This means PixelFormat::BGRA == PixelFormat::Unknown(FourCharCode::from_bytes(*b"BGRA")) — both round-trip to the same wire-level format — and they hash the same. Without this normalisation, the user-facing Unknown(known_code) footgun (constructing the variant with a code that already maps to a named variant) would silently produce two PixelFormat values that represent the same underlying format but compared unequal and indexed HashMaps twice.

Examples

use screencapturekit::stream::configuration::PixelFormat;
use screencapturekit::FourCharCode;

let format = PixelFormat::BGRA;
println!("Format: {}", format); // Prints "BGRA"

// Equality normalises through FourCharCode:
let synonym = PixelFormat::Unknown(FourCharCode::from_bytes(*b"BGRA"));
assert_eq!(PixelFormat::BGRA, synonym);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BGRA

Packed little-endian 32-bit BGRA — the default pixel format for streams created via crate::stream::configuration::SCStreamConfiguration::new.

The crate pins this format at construction time so that SCStreamConfiguration::new() delivers a stable BGRA wire format across macOS releases. Without the explicit pin Apple’s runtime chooses its own default, which on macOS 26 / Apple Silicon is 420v (bi-planar YCbCr) — silently breaking consumers that assume packed BGRA samples. See issue #145.

l10r

Packed little endian ARGB2101010 (10-bit color)

YCbCr_420v

Two-plane “video” range YCbCr 4:2:0

YCbCr_420f

Two-plane “full” range YCbCr 4:2:0

xf44

Two-plane “full” range YCbCr10 4:4:4 (10-bit)

RGhA

64-bit RGBA IEEE half-precision float, 16-bit little-endian (HDR)

Unknown(FourCharCode)

A pixel format reported by ScreenCaptureKit that this crate does not model as a named variant. The wrapped FourCharCode preserves the raw four-character code so callers can branch on it explicitly or log it for diagnostics.

Trait Implementations

impl Clone for PixelFormat

fn clone(&self) -> PixelFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PixelFormat

impl Debug for PixelFormat

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

Formats the value using the given formatter.

impl Default for PixelFormat

fn default() -> PixelFormat

Returns the “default value” for a type.

impl Display for PixelFormat

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

Formats the value using the given formatter.

impl Eq for PixelFormat

impl From<FourCharCode> for PixelFormat

fn from(val: FourCharCode) -> Self

Converts to this type from the input type.

impl From<PixelFormat> for FourCharCode

fn from(val: PixelFormat) -> Self

Converts to this type from the input type.

impl From<u32> for PixelFormat

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for PixelFormat

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 PixelFormat

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.