Enum FrameCaptureMode

pub enum FrameCaptureMode {
    Sporadic,
    Next,
    NextMask(ImageMaskMode),
    All,
    AllMask(ImageMaskMode),
}

Frame image capture mode in a window.

You can set the capture mode using WindowVars::frame_capture_mode.

Variants

Sporadic

Frames are not automatically captured, but you can use WINDOWS.frame_image to capture frames.

Next

The next rendered frame will be captured and available in FrameImageReadyArgs::frame_image as a full BGRA8 image.

After the frame is captured the mode changes to Sporadic.

NextMask(ImageMaskMode)

The next rendered frame will be captured and available in FrameImageReadyArgs::frame_image as an A8 mask image.

After the frame is captured the mode changes to Sporadic.

All

All subsequent frames rendered will be captured and available in FrameImageReadyArgs::frame_image as full BGRA8 images.

AllMask(ImageMaskMode)

All subsequent frames rendered will be captured and available in FrameImageReadyArgs::frame_image as A8 mask images.

Trait Implementations

impl Clone for FrameCaptureMode

fn clone(&self) -> FrameCaptureMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameCaptureMode

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

Formats the value using the given formatter.

impl Default for FrameCaptureMode

fn default() -> FrameCaptureMode

impl<'de> Deserialize<'de> for FrameCaptureMode

fn deserialize<__D>( __deserializer: __D, ) -> Result<FrameCaptureMode, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FrameCaptureMode

fn eq(&self, other: &FrameCaptureMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FrameCaptureMode

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FrameCaptureMode

impl Eq for FrameCaptureMode

impl StructuralPartialEq for FrameCaptureMode