Struct show_image::WindowHandle

pub struct WindowHandle<'a> { /* fields omitted */ }

Handle to a window.

A WindowHandle can be used to interact with a window from within the global context thread. To interact with a window from another thread, you need a WindowProxy.

Implementations

impl<'a> WindowHandle<'a>

pub fn new(context_handle: ContextHandle<'a>, window_id: WindowId) -> Self

Create a new window handle from a context handle and a window ID.

pub fn id(&self) -> WindowId

Get the window ID.

pub fn proxy(&self) -> WindowProxy

Get a proxy object for the window to interact with it from a different thread.

You should not use proxy objects from withing the global context thread. The proxy objects often wait for the global context to perform some action. Doing so from within the global context thread would cause a deadlock.

pub fn context_handle(&mut self) -> &mut ContextHandle<'a>

Get the context handle as mutable reference.

pub fn destroy(&mut self) -> Result<(), InvalidWindowId>

Destroy the window.

Any subsequent operation on the window will return InvalidWindowId.

pub fn image_info(
    &self
) -> Result<Option<(ImageInfo, Rectangle)>, InvalidWindowId>

Get the image info and the area of the window where the image is drawn.

pub fn set_visible(&mut self, visible: bool) -> Result<(), InvalidWindowId>

Make the window visible or invisible.

pub fn set_options<F>(&mut self, make_options: F) -> Result<(), InvalidWindowId> where
    F: FnOnce(&WindowOptions) -> WindowOptions, 

Change the options of the window.

pub fn set_image(
    &mut self,
    name: impl Into<String>,
    image: &impl AsImageView
) -> Result<(), SetImageError>

Set the image to display on the window.

pub fn add_overlay(
    &mut self,
    name: impl Into<String>,
    image: &impl AsImageView
) -> Result<(), SetImageError>

Add an overlay to the window.

Overlays are drawn on top of the image. Overlays remain active until you call they are cleared.

pub fn clear_overlays(&mut self) -> Result<(), InvalidWindowId>

Clear the overlays of the window.

pub fn add_event_handler<F>(
    &mut self,
    handler: F
) -> Result<(), InvalidWindowId> where
    F: 'static + FnMut(&mut WindowHandle<'_>, &mut WindowEvent, &mut EventHandlerControlFlow), 

Add an event handler to the window.