core: Fix various documentation errors in video
This commit is contained in:
parent
c5fa9eb4a8
commit
d9541e1ea6
|
@ -111,10 +111,10 @@ pub struct NullVideoBackend {
|
||||||
///
|
///
|
||||||
/// Specifically:
|
/// Specifically:
|
||||||
///
|
///
|
||||||
/// * Registering a video stream fails silently
|
/// * Registering a video stream succeeds but does nothing
|
||||||
/// * All video frames are silently marked as keyframes
|
/// * All video frames are silently marked as keyframes
|
||||||
/// * Video stream decoding fails (since we can't pump arbitrary bitmaps into
|
/// * Video stream decoding fails with an error that video decoding is
|
||||||
/// arbitrary renderers)
|
/// unimplemented
|
||||||
impl NullVideoBackend {
|
impl NullVideoBackend {
|
||||||
pub fn new() -> Self {
|
pub fn new() -> Self {
|
||||||
Self {
|
Self {
|
||||||
|
|
|
@ -10,11 +10,8 @@ use swf::{VideoCodec, VideoDeblocking};
|
||||||
/// A single preloaded video stream.
|
/// A single preloaded video stream.
|
||||||
pub enum VideoStream {}
|
pub enum VideoStream {}
|
||||||
|
|
||||||
/// Desktop video backend.
|
/// Software video backend that proxies to CPU-only codec implementations that
|
||||||
///
|
/// ship with Ruffle.
|
||||||
/// TODO: Currently, this just proxies out to `ruffle_h263`, in the future it
|
|
||||||
/// should support desktop media playback APIs so we can take advantage of
|
|
||||||
/// hardware-accelerated video decoding.
|
|
||||||
pub struct SoftwareVideoBackend {
|
pub struct SoftwareVideoBackend {
|
||||||
streams: Arena<VideoStream>,
|
streams: Arena<VideoStream>,
|
||||||
}
|
}
|
||||||
|
|
|
@ -57,6 +57,7 @@ pub struct VideoData<'gc> {
|
||||||
#[derive(Clone, Debug, Collect)]
|
#[derive(Clone, Debug, Collect)]
|
||||||
#[collect(require_static)]
|
#[collect(require_static)]
|
||||||
pub enum VideoSource {
|
pub enum VideoSource {
|
||||||
|
/// A video bitstream embedded inside of a SWF movie.
|
||||||
SWF {
|
SWF {
|
||||||
/// The movie that defined this video stream.
|
/// The movie that defined this video stream.
|
||||||
movie: Arc<SwfMovie>,
|
movie: Arc<SwfMovie>,
|
||||||
|
@ -64,7 +65,7 @@ pub enum VideoSource {
|
||||||
/// The video stream definition.
|
/// The video stream definition.
|
||||||
streamdef: DefineVideoStream,
|
streamdef: DefineVideoStream,
|
||||||
|
|
||||||
/// The H.263 bitstream indexed by video frame ID.
|
/// The locations of each embedded sub-bitstream for each video frame.
|
||||||
///
|
///
|
||||||
/// Each frame consists of a start and end parameter which can be used
|
/// Each frame consists of a start and end parameter which can be used
|
||||||
/// to reconstruct a reference to the embedded bitstream.
|
/// to reconstruct a reference to the embedded bitstream.
|
||||||
|
|
Loading…
Reference in New Issue