Struct PixelFormatInfo 

pub struct PixelFormatInfo { /* private fields */ }

Compile-time pixel format properties.

This struct encapsulates all format-specific knowledge in one location, providing a single source of truth for buffer size calculations, stride computation, and format category detection.

Examples

use grafton_ndi::{PixelFormat, FormatCategory};

let info = PixelFormat::BGRA.info();
assert_eq!(info.bytes_per_pixel(), 4);
assert_eq!(info.category(), FormatCategory::Packed);

let info = PixelFormat::NV12.info();
assert_eq!(info.bytes_per_pixel(), 1);
assert_eq!(info.category(), FormatCategory::SemiPlanar420);

Implementations

impl PixelFormatInfo

pub const fn bytes_per_pixel(&self) -> u8

Get bytes per pixel for packed formats, or first-plane bytes per pixel for planar and semi-planar formats (the Y plane, or the UYVY plane of UYVA).

pub const fn category(&self) -> FormatCategory

Get the format category.

pub const fn is_planar_420(&self) -> bool

Returns true if this is a planar 4:2:0 format (YV12, I420, or NV12).

pub fn try_buffer_len(&self, y_stride: i32, height: i32) -> Result<usize>

Calculate total buffer size for given dimensions and stride using checked arithmetic.

Arguments

• y_stride - The first-plane line stride in bytes (for planar formats) or total line stride (for packed formats)
• height - Frame height in pixels

Errors

Returns Error::InvalidFrame if y_stride or height is not positive, if planar 4:2:0 stride/height requirements are not met, if arithmetic overflows, or if the result exceeds the crate’s maximum video frame size.

Format-specific calculations

• Packed RGB/YUV (BGRA/BGRX/RGBA/RGBX/UYVY): y_stride * height
• Packed 4:2:2 with alpha UYVA: requires even stride, then UYVY + A where:
  • UYVY plane: y_stride * height
  • Alpha plane: (y_stride/2) * height
• Semi-planar 4:2:2 P216: Y + CbCr where each plane is y_stride * height
• Semi-planar 4:2:2 with alpha PA16: Y + CbCr + A where each plane is y_stride * height
• Planar 4:2:0 YV12/I420: requires even stride and height, then Y + U + V where:
  • Y plane: y_stride * height
  • U plane: (y_stride/2) * (height/2)
  • V plane: (y_stride/2) * (height/2)
• Semi-planar 4:2:0 NV12: requires even height, then Y + UV where:
  • Y plane: y_stride * height
  • UV plane: y_stride * (height/2)

Trait Implementations

impl Clone for PixelFormatInfo

fn clone(&self) -> PixelFormatInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PixelFormatInfo

impl Debug for PixelFormatInfo

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

Formats the value using the given formatter.

impl Eq for PixelFormatInfo

impl PartialEq for PixelFormatInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PixelFormatInfo