package mm

  1. Overview
  2. Docs
package mm
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Video.CanvasSource

Sourcemodule Image : sig ... end
Sourcetype image = Image.t

An image.

Sourcetype t = image array

A video.

Sourceval make : int -> (int * int) -> t

Create a video with given length and dimensions.

Sourceval copy : t -> t

Make a copy of the video (images themselves are not copied since they are supposed to be immutable).

Sourceval single : Image.t -> t

Create a video with one canvas image.

Sourceval single_image : Mm_image.Image.YUV420.t -> t

Create a video with one image.

Sourceval length : t -> int

Length of the video (in images).

Sourceval size : t -> int

Estimated size of the video (in bytes).

Sourceval get : t -> int -> image

Get the nth image of the video.

Sourceval set : t -> int -> image -> unit

Set the nth image of the video.

Sourceval map_image : (image -> image) -> t -> int -> unit

Apply a function on the nth image of the video.

Sourceval render : ?transparent:bool -> t -> int -> Mm_image.Image.YUV420.t

Render the nth image of the video.

Sourceval put : t -> int -> Mm_image.Image.YUV420.t -> unit

Change the contents of the nth image of the video (like set but takes an image instead of a canvas as argument).

Sourceval blank : t -> int -> int -> unit

Blank the video starting at offset with given length.

Sourceval blit : t -> int -> t -> int -> int -> unit

Copy the images of one video to the other.

Sourceval map : (image -> image) -> t -> int -> int -> unit

Map a function to the images of a video (starting at given offset, for given length).

Sourceval iter : (Mm_image.Image.YUV420.t -> unit) -> t -> int -> int -> unit

Iterate a function on the rendering of the images of the video.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct