Struct sixtyfps_corelib::graphics::GraphicsWindow

pub struct GraphicsWindow<Backend: GraphicsBackend + 'static> { /* fields omitted */ }

GraphicsWindow is an implementation of the GenericWindow trait. This is typically instantiated by entry factory functions of the different graphics backends.

Implementations

impl<Backend: GraphicsBackend + 'static> GraphicsWindow<Backend>

pub fn new(
    graphics_backend_factory: impl Fn(&EventLoop, WindowBuilder) -> Backend + 'static
) -> Rc<Self>

Creates a new reference-counted instance.

Arguments:

• graphics_backend_factory: The factor function stored in the GraphicsWindow that's called when the state of the window changes to mapped. The event loop and window builder parameters can be used to create a backing window.

pub fn id(&self) -> Option<WindowId>

Returns the window id of the window if it is mapped, None otherwise.

Trait Implementations

impl<Backend: GraphicsBackend> Drop for GraphicsWindow<Backend>

pub fn drop(&mut self)

Executes the destructor for this type.

impl<Backend: GraphicsBackend> GenericWindow for GraphicsWindow<Backend>

pub fn set_component(self: Rc<Self>, component: &ComponentRc)

Associates this window with the specified component. Further event handling and rendering, etc. will be done with that component.

pub fn draw(self: Rc<Self>)

Draw the items of the specified component in the given window.

pub fn process_mouse_input(
    self: Rc<Self>,
    pos: PhysicalPosition<f64>,
    what: MouseEventType
)

Receive a mouse event and pass it to the items of the component to change their state.

pub fn process_key_input(self: Rc<Self>, event: &KeyEvent)

Receive a key event and pass it to the items of the component to change their state.

pub fn with_platform_window(&self, callback: &dyn Fn(&Window))

Calls the callback function with the underlying winit::Window that this GenericWindow backs.

pub fn map_window(self: Rc<Self>, event_loop: &EventLoop)

Requests for the window to be mapped to the screen.

pub fn request_redraw(&self)

Issue a request to the windowing system to re-render the contents of the window. This is typically an asynchronous request.

pub fn unmap_window(self: Rc<Self>)

Removes the window from the screen. The window is not destroyed though, it can be show (mapped) again later by calling GenericWindow::map_window.

pub fn scale_factor(&self) -> f32

Returns the scale factor set on the window, as provided by the windowing system.

pub fn set_scale_factor(&self, factor: f32)

Sets an overriding scale factor for the window. This is typically only used for testing.

pub fn set_width(&self, width: f32)

Sets the size of the window to the specified width. This method is typically called in response to receiving a window resize event from the windowing system.

pub fn set_height(&self, height: f32)

Sets the size of the window to the specified height. This method is typically called in response to receiving a window resize event from the windowing system.

pub fn get_geometry(&self) -> Rect

Returns the geometry of the window

pub fn free_graphics_resources<'a>(
    self: Rc<Self>,
    items: &Slice<'a, Pin<ItemRef<'a>>>
)

This function is called by the generated code when a component and therefore its tree of items are destroyed. The implementation typically uses this to free the underlying graphics resources cached via crate::graphics::RenderingCache.

pub fn set_cursor_blink_binding(&self, prop: &Property<bool>)

Installs a binding on the specified property that's toggled whenever the text cursor is supposed to be visible or not.

pub fn current_keyboard_modifiers(&self) -> KeyboardModifiers

Returns the currently active keyboard notifiers.

pub fn set_current_keyboard_modifiers(&self, state: KeyboardModifiers)

Sets the currently active keyboard notifiers. This is used only for testing or directly from the event loop implementation.

pub fn set_focus_item(self: Rc<Self>, focus_item: &ItemRc)

Sets the focus to the item pointed to by item_ptr. This will remove the focus from any currently focused item.

pub fn set_focus(self: Rc<Self>, have_focus: bool)

Sets the focus on the window to true or false, depending on the have_focus argument. This results in WindowFocusReceived and WindowFocusLost events.

pub fn show_popup(&self, popup: &ComponentRc, position: Point)

Show a popup at the given position

pub fn close_popup(&self)

Close the active popup if any