Struct FrameImageReadyArgs

pub struct FrameImageReadyArgs {
    pub timestamp: DInstant,
    pub window_id: WindowId,
    pub frame_id: FrameId,
    pub frame_image: Option<Img>,
    /* private fields */
}

FRAME_IMAGE_READY_EVENT args.

Fields

timestamp: DInstant

Instant the event happened.

window_id: WindowId

Window ID.

frame_id: FrameId

Frame that finished rendering.

This is probably the ID of frame pixels if they are requested immediately.

frame_image: Option<Img>

The frame pixels if it was requested when the frame request was sent to the view-process.

See WindowVars::frame_capture_mode for more details.

Implementations

impl FrameImageReadyArgs

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, window_id: impl Into<WindowId>, frame_id: impl Into<FrameId>, frame_image: impl Into<Option<Img>>, ) -> Self

New args from values that convert into the argument types.

pub fn now( window_id: impl Into<WindowId>, frame_id: impl Into<FrameId>, frame_image: impl Into<Option<Img>>, ) -> Self

Arguments for event that happened now (INSTANT.now).

Trait Implementations

impl AnyEventArgs for FrameImageReadyArgs

fn delivery_list(&self, list: &mut UpdateDeliveryList)

Broadcast to all widgets.

fn clone_any(&self) -> Box<dyn AnyEventArgs>

Clone the event into a type erased box.

fn as_any(&self) -> &dyn Any

Access to dyn Any methods.

fn timestamp(&self) -> DInstant

Gets the instant this event happened.

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance.

impl Clone for FrameImageReadyArgs

fn clone(&self) -> FrameImageReadyArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameImageReadyArgs

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

Formats the value using the given formatter.

impl EventArgs for FrameImageReadyArgs

fn handle<F, R>(&self, handler: F) -> Option<R>

where F: FnOnce(&Self) -> R,

Calls handler and stops propagation if propagation is still allowed.