Enum ScanType 

#[non_exhaustive]
#[repr(u32)]
pub enum ScanType {
    Progressive = 1,
    Interlaced = 0,
    Field0 = 2,
    Field1 = 3,
}

Video scan type (progressive, interlaced, or field-based).

This enum describes how video frames are scanned/displayed. Most modern content uses Progressive, while legacy broadcast may use Interlaced or field-based formats.

This enum is marked #[non_exhaustive] to allow future NDI SDK versions to add new scan types without breaking existing code. Always use a wildcard pattern when matching.

Examples

use grafton_ndi::ScanType;

let scan = ScanType::Progressive;

// When matching, always include a wildcard for forward compatibility
match scan {
    ScanType::Progressive => println!("Progressive scan"),
    ScanType::Interlaced => println!("Interlaced"),
    _ => println!("Field-based or other"),
}

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.

Progressive = 1

Progressive scan - full frames rendered sequentially.

Interlaced = 0

Interlaced scan - alternating even/odd lines.

Field0 = 2

Field 0 only (first field of interlaced content).

Field1 = 3

Field 1 only (second field of interlaced content).

Trait Implementations

impl Clone for ScanType

fn clone(&self) -> ScanType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanType

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

Formats the value using the given formatter.

impl From<ScanType> for i32

fn from(value: ScanType) -> Self

Converts to this type from the input type.

impl From<ScanType> for u32

fn from(enum_value: ScanType) -> Self

Converts to this type from the input type.

impl PartialEq for ScanType

fn eq(&self, other: &ScanType) -> 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 TryFrom<u32> for ScanType

type Error = TryFromPrimitiveError<ScanType>

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for ScanType

const NAME: &'static str = "ScanType"

type Primitive = u32

type Error = TryFromPrimitiveError<ScanType>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for ScanType

impl Eq for ScanType

impl StructuralPartialEq for ScanType