Struct show_image::WindowProxy[][src]

pub struct WindowProxy { /* fields omitted */ }
Expand description

Proxy object to interact with a window from a user thread.

The proxy object only exposes a small subset of the functionality of a window. However, you can use run_function() to get access to the underlying WindowHandle from the context thread. With run_function_wait() you can also get the return value of the function back:

let inner_size = window_proxy.run_function_wait(|window| window.inner_size())?;

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.

Implementations

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

Get the window ID.

Get the context proxy of the window proxy.

Set the displayed image of the window.

The real work is done in the context thread. This function blocks until the context thread has performed the action.

Note that you can not change the overlays with this function. To modify those, you can use Self::run_function or Self::run_function_wait to get access to the WindowHandle.

Panics

This function will panic if called from within the context thread.

Add an event handler for the window.

Events that are already queued with the event loop will not be passed to the handler.

This function uses ContextProxy::run_function_wait internally, so it blocks until the event handler is added. To avoid blocking, you can use ContextProxy::run_function to post a lambda that adds an event handler instead.

Panics

This function will panic if called from within the context thread.

Create a channel that receives events from the window.

To close the channel, simply drop de receiver. The channel is closed automatically when the window is destroyed.

Warning: The created channel blocks when you request an event until one is available. You should never use the receiver from within an event handler or a function posted to the global context thread. Doing so would cause a deadlock.

Panics

This function will panic if called from within the context thread.

Wait for the window to be destroyed.

This can happen if the application code destroys the window or if the user closes the window.

Warning: This function blocks until the window is closed. You should never use this function from within an event handler or a function posted to the global context thread. Doing so would cause a deadlock.

Panics

This function will panic if called from within the context thread.

Post a function for execution in the context thread without waiting for it to execute.

This function returns immediately, without waiting for the posted function to start or complete. If you want to get a return value back from the function, use Self::run_function_wait instead.

Note: You should not use this to post functions that block for a long time. Doing so will block the event loop and will make the windows unresponsive until the event loop can continue. Consider using self.context_proxy().run_background_task(...) for long blocking tasks instead.

Panics

This function will panic if called from within the context thread.

Post a function for execution in the context thread and wait for the return value.

If you do not need a return value from the posted function, you can use Self::run_function to avoid blocking the calling thread until it completes.

Note: You should not use this to post functions that block for a long time. Doing so will block the event loop and will make the windows unresponsive until the event loop can continue. Consider using self.context_proxy().run_background_task(...) for long blocking tasks instead.

Panics

This function will panic if called from within the context thread.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.