Struct VideoPlayer 

pub struct VideoPlayer<Api: Api = Default, const FREE_ON_DROP: bool = true>(/* private fields */);

Implementations

impl<Api: Api + Copy> VideoPlayer<Api, true>

pub fn into_shared(self) -> VideoPlayer<Api, false>

Convert this video player into the same but that will not be freed on drop. That means that only C-part of the player will not be freed.

Safety is guaranteed by the caller.

impl<Api: Api> VideoPlayer<Api, true>

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self, ApiError>

where Api: Default,

Opens the pdv file at path and returns a new video player object for rendering its frames.

Calls sys::ffi::playdate_video::loadVideo.

pub fn load_with<P: AsRef<Path>>(api: Api, path: P) -> Result<Self, ApiError>

Opens the pdv file at path and returns a new video player object for rendering its frames.

Calls sys::ffi::playdate_video::loadVideo.

impl<Api: Api, const FOD: bool> VideoPlayer<Api, FOD>

pub fn set_context<'a, 'b: 'a>( &'a self, bitmap: &'b impl AnyBitmap, ) -> Result<(), Error>

Sets the rendering destination for the video player to the given bitmap.

If the function fails, it returns Error::Video if err-message supplied by C-API, or Error::Unknown in other cases.

Calls sys::ffi::playdate_video::setContext.

pub fn get_context(&self) -> Result<BitmapRef<'_>, Error>

Gets the rendering destination for the video player.

If no rendering context has been set allocates a context bitmap with the same dimensions as the video will be allocated.

Calls sys::ffi::playdate_video::getContext.

pub fn use_screen_context(&self)

Calls sys::ffi::playdate_video::useScreenContext.

pub fn render_frame(&self, n: c_int) -> Result<(), Error>

Renders frame number n into the current context.

In case of error, it returns Error::Video if err-message supplied by C-API, or Error::Unknown in other cases.

Calls sys::ffi::playdate_video::renderFrame.

pub fn info(&self) -> VideoPlayerOutInfo

Retrieves information about the video.

Calls sys::ffi::playdate_video::renderFrame.

pub fn info_to(&self, info: &mut VideoPlayerOutInfo)

Retrieves information about the video, by passing values into given info.

Calls sys::ffi::playdate_video::renderFrame.

pub fn info_raw( &self, width: Option<&mut c_int>, height: Option<&mut c_int>, frame_rate: Option<&mut c_float>, frame_count: Option<&mut c_int>, current_frame: Option<&mut c_int>, )

Retrieves information about the video, by passing optional mutable references.

Example:

let mut frame_count = Some(0);
let mut current_frame = Some(0);
player.info_raw(None, None, None,
                frame_count.as_mut(),
                current_frame.as_mut()
               );
println!( "{}/{}", current_frame.unwrap(), frame_count.unwrap());

Calls sys::ffi::playdate_video::renderFrame.

pub fn get_error(&self) -> Option<Error>

Returns Error with text describing the most recent error.

Inner text is borrowed by C, so it should be used immediately or converted to something owned.

See also VideoPlayer::get_error_cstr.

Calls sys::ffi::playdate_video::getError.

pub fn get_error_cstr(&self) -> Option<&CStr>

Returns [CStr] describing the most recent error.

String-slice is borrowed by C, so it should be used immediately or converted to something owned.

Calls sys::ffi::playdate_video::getError.

Trait Implementations

impl<Api: Debug + Api, const FREE_ON_DROP: bool> Debug for VideoPlayer<Api, FREE_ON_DROP>

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

Formats the value using the given formatter.

impl<Api: Api, const FOD: bool> Drop for VideoPlayer<Api, FOD>

fn drop(&mut self)

Executes the destructor for this type.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.