Enum ndi::FrameFormatType

pub enum FrameFormatType {
    Progressive,
    Interleaved,
    Field0,
    Field1,
}

A description of the frome format of a frame

This is usually part of a VideoData frame.

To make everything as easy to use as possible, the SDK always assumes that fields are ‘top field first’. This is, in fact, the case for every modern format, but does create a problem for two specific older video formats as discussed below:

NTSC 486 LINES

The best way to handle this format is simply to offset the image vertically by one line (p_uyvy_data + uyvy_stride_in_bytes) and reduce the vertical resolution to 480 lines. This can all be done without modification of the data being passed in at all; simply change the data and resolution pointers.

DV NTSC

This format is a relatively rare these days, although still used from time to time. There is no entirely trivial way to handle this other than to move the image down one line and add a black line at the bottom.

Variants

Progressive

This is a progressive video frame

Interleaved

This is a frame of video that is comprised of two fields.

The upper field comes first, and the lower comes second (see FrameFormatType)

Field0

This is an individual field 0 from a fielded video frame.

This is the first temporal, upper field. (see FrameFormatType)

Field1

This is an individual field 1 from a fielded video frame.

This is the second temporal, lower field (see FrameFormatType)

Trait Implementations

impl Clone for FrameFormatType

fn clone(&self) -> FrameFormatType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameFormatType

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

Formats the value using the given formatter.

impl PartialEq<FrameFormatType> for FrameFormatType

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl TryFrom<i32> for FrameFormatType

type Error = InvalidEnum

The type returned in the event of a conversion error.

fn try_from(value: NDIlib_frame_format_type_e) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for FrameFormatType

impl Eq for FrameFormatType

impl StructuralEq for FrameFormatType

impl StructuralPartialEq for FrameFormatType