Struct Animation 

pub struct Animation { /* private fields */ }

Represents an animation with multiple frames. The Animation struct is designed to store and manage data for animated sequences such as those from animated formats (e.g., GIF, AVIF, APNG, WebP). It provides support for looping, background color settings, frame timing, and frame storage.

Implementations

impl Animation

pub fn new(loop_count: i32, bg_color: Scalar) -> Result<Animation>

Constructs an Animation object with optional loop count and background color.

Parameters

• loopCount: An integer representing the number of times the animation should loop:

• 0 (default) indicates infinite looping, meaning the animation will replay continuously.
• Positive values denote finite repeat counts, allowing the animation to play a limited number of times.
• If a negative value or a value beyond the maximum of 0xffff (65535) is provided, it is reset to 0 (infinite looping) to maintain valid bounds.

• bgColor: A Scalar object representing the background color in BGR format:

• Defaults to Scalar(), indicating an empty color (usually transparent if supported).
• This background color provides a solid fill behind frames that have transparency, ensuring a consistent display appearance.

C++ default parameters

• loop_count: 0
• bg_color: Scalar()

pub fn new_def() -> Result<Animation>

Constructs an Animation object with optional loop count and background color.

Parameters

• loopCount: An integer representing the number of times the animation should loop:

• 0 (default) indicates infinite looping, meaning the animation will replay continuously.
• Positive values denote finite repeat counts, allowing the animation to play a limited number of times.
• If a negative value or a value beyond the maximum of 0xffff (65535) is provided, it is reset to 0 (infinite looping) to maintain valid bounds.

• bgColor: A Scalar object representing the background color in BGR format:

• Defaults to Scalar(), indicating an empty color (usually transparent if supported).
• This background color provides a solid fill behind frames that have transparency, ensuring a consistent display appearance.

Note

This alternative version of [new] function uses the following default values for its arguments:

• loop_count: 0
• bg_color: Scalar()

Trait Implementations

impl AnimationTrait for Animation

fn as_raw_mut_Animation(&mut self) -> *mut c_void

fn set_loop_count(&mut self, val: i32)

Number of times the animation should loop. 0 means infinite looping.

fn set_bgcolor(&mut self, val: Scalar)

Background color of the animation in BGRA format.

fn set_durations(&mut self, val: Vector<i32>)

Duration for each frame in milliseconds.

fn set_frames(&mut self, val: Vector<Mat>)

Vector of frames, where each Mat represents a single frame.

fn set_still_image(&mut self, val: Mat)

image that can be used for the format in addition to the animation or if animation is not supported in the reader (like in PNG).

impl AnimationTraitConst for Animation

fn as_raw_Animation(&self) -> *const c_void

fn loop_count(&self) -> i32

Number of times the animation should loop. 0 means infinite looping.

fn bgcolor(&self) -> Scalar

Background color of the animation in BGRA format.

fn durations(&self) -> Vector<i32>

Duration for each frame in milliseconds.

fn frames(&self) -> Vector<Mat>

Vector of frames, where each Mat represents a single frame.

fn still_image(&self) -> Mat

image that can be used for the format in addition to the animation or if animation is not supported in the reader (like in PNG).

impl Boxed for Animation

unsafe fn from_raw(ptr: <Animation as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <Animation as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <Animation as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self, ) -> <Animation as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Clone for Animation

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Animation

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

Formats the value using the given formatter.

impl Drop for Animation

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Animation