Enum NDIPreferredColorFormat 

#[non_exhaustive]
#[repr(i32)]
pub enum NDIPreferredColorFormat {
    Fastest = 100,
    Best = 101,
    BGRX_BGRA = 0,
    UYVY_BGRA = 1,
    RGBX_RGBA = 2,
    UYVY_RGBA = 3,
}

This enum describes the preferred color format for receiving video frames. If you can handle all color formats you should use Fastest

C equivalent: NDIlib_recv_color_format_e

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.

Fastest = 100

Best = 101

BGRX_BGRA = 0

UYVY_BGRA = 1

RGBX_RGBA = 2

UYVY_RGBA = 3

Implementations

impl NDIPreferredColorFormat

pub const fn without_alpha_four_cc(self) -> Option<FourCCVideo>

Returns the FourCC type that will be used for frames without alpha channel.

None indicates that the resulting FourCC type cannot statically be known

pub const fn with_alpha_four_cc(self) -> Option<FourCCVideo>

Returns the FourCC type that will be used for frames with alpha channel.

None indicates that the resulting FourCC type cannot statically be known

pub fn from_four_cc( with_alpha: Option<FourCCVideo>, without_alpha: Option<FourCCVideo>, ) -> Result<Self, FromFourCCError>

Tries to create a preferred color format from the given FourCC types.

Only a few combinations are allowed by the SDK, in case of an unsupported combination this will return Err(FromFourCCError::UnsupportedCombination).

A None argument means Don’t care

Trait Implementations

impl Clone for NDIPreferredColorFormat

fn clone(&self) -> NDIPreferredColorFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NDIPreferredColorFormat

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

Formats the value using the given formatter.

impl Default for NDIPreferredColorFormat

fn default() -> NDIPreferredColorFormat

Returns the “default value” for a type.

impl From<NDIPreferredColorFormat> for i32

fn from(enum_value: NDIPreferredColorFormat) -> Self

Converts to this type from the input type.

impl PartialEq for NDIPreferredColorFormat

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

type Error = TryFromPrimitiveError<NDIPreferredColorFormat>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFromPrimitive for NDIPreferredColorFormat

const NAME: &'static str = "NDIPreferredColorFormat"

type Primitive = i32

type Error = TryFromPrimitiveError<NDIPreferredColorFormat>

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

impl Copy for NDIPreferredColorFormat

impl Eq for NDIPreferredColorFormat

impl StructuralPartialEq for NDIPreferredColorFormat