Struct x264::Image

pub struct Image<'a> { /* private fields */ }

Input image data to be given to the encoder.

Implementations

impl<'a> Image<'a>

pub fn new<E: Into<Encoding>>(
    format: E,
    width: i32,
    height: i32,
    planes: &[Plane<'a>]
) -> Self

Makes a new image with the given information.

Panics

Panics if the plane is invalid.

pub fn bgr(width: i32, height: i32, data: &'a [u8]) -> Self

Makes a new packed BGR image.

pub fn rgb(width: i32, height: i32, data: &'a [u8]) -> Self

Makes a new packed RGB image.

pub fn bgra(width: i32, height: i32, data: &'a [u8]) -> Self

Makes a new packed BGRA image.

pub unsafe fn new_unchecked(
    format: Encoding,
    width: i32,
    height: i32,
    planes: &[Plane<'a>]
) -> Self

Makes a new image with the given planes and colorspace.

Unsafety

The caller must ensure that the plane fulfils all the invariants that x264 expects it to fulfil. I don’t actually know what all of those are, but the source of Encoder::new is my best guess.

pub fn width(&self) -> i32

The width of the image.

pub fn height(&self) -> i32

The height of the image.

pub fn encoding(&self) -> Encoding

The encoding of the image.