Struct libva::Picture

pub struct Picture<S: PictureState> {
    inner: Box<PictureInner>,
    phantom: PhantomData<S>,
}

A Surface that is being rendered into.

This struct abstracts the decoding flow using vaBeginPicture, vaRenderPicture, vaEndPicture and vaSyncSurface in a type-safe way.

The surface will have valid picture data after all the stages of decoding are called.

Fields

inner: Box<PictureInner>

phantom: PhantomData<S>

Implementations

impl Picture<PictureNew>

pub fn new(timestamp: u64, context: Rc<Context>, surface: Surface) -> Self

Creates a new Picture with a given timestamp. surface is the underlying surface that libva will render to.

pub fn new_from_same_surface<T: PictureReclaimableSurface, S: PictureReclaimableSurface>(
    timestamp: u64,
    picture: &Picture<S>
) -> Picture<T>

Creates a new Picture with a given frame_number to identify it, reusing the Surface from picture. This is useful for interlaced decoding as one can render both fields to the same underlying surface.

pub fn add_buffer(&mut self, buffer: Buffer)

Add buffer to the picture.

pub fn begin(self) -> Result<Picture<PictureBegin>>

Wrapper around vaBeginPicture.

impl Picture<PictureBegin>

pub fn render(self) -> Result<Picture<PictureRender>>

Wrapper around vaRenderPicture.

impl Picture<PictureRender>

pub fn end(self) -> Result<Picture<PictureEnd>>

Wrapper around vaEndPicture.

impl Picture<PictureEnd>

pub fn sync(self) -> Result<Picture<PictureSync>>

Syncs the picture, ensuring that all pending operations are complete when this call returns.

pub fn query_status(&self) -> Result<Type>

Queries the status of the underlying surface.

This call can be used to implement a non-blocking path, wherein a decoder queries the status of the surface after each decode operation instead of blocking on it.

impl<S: PictureState> Picture<S>

pub fn timestamp(&self) -> u64

Returns the timestamp of this picture.

pub(crate) fn inner(&self) -> &PictureInner

Returns a reference to the inner struct.

impl<S: PictureReclaimableSurface> Picture<S>

pub fn take_surface(self) -> Result<Surface>

Reclaim ownership of the Surface this picture has been created from, consuming the picture in the process. Useful if the Surface is part of a pool.

pub fn surface(&self) -> Ref<'_, Surface>

Returns a reference to the underlying Surface for this Picture

pub fn surface_mut(&mut self) -> RefMut<'_, Surface>

Returns a mutable reference to the underlying Surface for this Picture