Struct gooey::context::GraphicsContext

pub struct GraphicsContext<'context, 'window, 'clip, 'gfx, 'pass> {
    pub widget: WidgetContext<'context, 'window>,
    pub gfx: Exclusive<'context, Graphics<'clip, 'gfx, 'pass>>,
}

A context to a function that is rendering a widget.

Fields

widget: WidgetContext<'context, 'window>

The context of the widget being rendered.

gfx: Exclusive<'context, Graphics<'clip, 'gfx, 'pass>>

The graphics context clipped and offset to the area of the widget being rendered. Drawing at 0,0 will draw at the top-left pixel of the laid-out widget region.

Implementations

impl<'context, 'window, 'clip, 'gfx, 'pass> GraphicsContext<'context, 'window, 'clip, 'gfx, 'pass>

pub fn borrowed(&mut self) -> GraphicsContext<'_, 'window, 'clip, 'gfx, 'pass>

Returns a new instance that borrows from self.

pub fn for_other<'child, Widget>( &'child mut self, widget: &Widget ) -> <Widget::Managed as MapManagedWidget<GraphicsContext<'child, 'window, 'child, 'gfx, 'pass>>>::Result

where Widget: ManageWidget, Widget::Managed: MapManagedWidget<GraphicsContext<'child, 'window, 'child, 'gfx, 'pass>>,

Returns a new GraphicsContext that allows invoking graphics functions for widget.

pub fn apply_opacity(&mut self, opacity: impl Into<ZeroToOne>)

Updates self to have opacity.

This setting will be mixed with the current opacity value.

pub fn clipped_to( &mut self, clip: Rect<Px> ) -> GraphicsContext<'_, 'window, '_, 'gfx, 'pass>

Returns a new graphics context that renders to the clip rectangle.

pub fn fill(&mut self, color: Color)

Fills the background of this widget with color, honoring the current CornerRadius setting.

If the alpha channel of color is 0, this function does nothing.

pub fn stroke_outline<Unit>( &mut self, color: Color, options: StrokeOptions<Unit> )

where Unit: ScreenScale<Px = Px, Lp = Lp, UPx = UPx> + Zero,

Strokes an outline around this widget’s contents.

pub fn draw_focus_ring(&mut self)

Renders the default focus ring for this widget.

pub fn apply_current_font_settings(&mut self)

Applies the current style settings for font family, text size, font style, and font weight.

pub fn redraw(&mut self)

Invokes Widget::redraw() on this context’s widget.

Panics

This function panics if the widget being drawn has no layout set (via LayoutContext::set_child_layout()).

Methods from Deref<Target = WidgetContext<'context, 'window>>

pub fn borrowed(&mut self) -> WidgetContext<'_, 'window>

Returns a new instance that borrows from self.

pub fn for_other<'child, Widget>( &'child mut self, widget: &Widget ) -> <Widget::Managed as MapManagedWidget<WidgetContext<'child, 'window>>>::Result

where Widget: ManageWidget, Widget::Managed: MapManagedWidget<WidgetContext<'child, 'window>>,

Returns a new context representing widget.

pub fn is_child_of(&self, possible_parent: &WidgetInstance) -> bool

Returns true if possible_parent is in this widget’s parent list.

pub fn enabled(&self) -> bool

Returns true if this widget is enabled.

pub fn redraw_when_changed(&self, value: &impl Trackable)

Ensures that this widget will be redrawn when value has been updated.

pub fn invalidate_when_changed(&self, value: &impl Trackable)

Ensures that this widget will be redrawn when value has been updated.

pub fn last_layout(&self) -> Option<Rect<Px>>

Returns the last layout of this widget.

pub fn focus(&mut self)

Sets the currently focused widget to this widget.

Widget events relating to focus changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn blur(&mut self) -> bool

Clears focus from this widget, if it is the focused widget.

Returns true if this function resulted in the focus being changed.

Widget events relating to focus changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn focus_is_advancing(&mut self) -> bool

Returns true if the last focus event was an advancing motion, not a returning motion.

This value is meaningless outside of focus-related events.

pub fn activate(&mut self) -> bool

Activates this widget, if it is not already active.

Returns true if this function resulted in the currently active widget being changed.

Widget events relating to activation changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn deactivate(&mut self) -> bool

Deactivates this widget, if it is the currently active widget.

Returns true if this function resulted in the active widget being changed.

Widget events relating to activation changes are deferred until after the all contexts for the currently firing event are dropped.

pub fn active(&self) -> bool

Returns true if this widget is currently the active widget.

pub fn hovered(&self) -> bool

Returns true if this widget is currently hovered, even if the cursor is over a child widget.

pub fn primary_hover(&self) -> bool

Returns true if this widget that is directly beneath the cursor.

pub fn focused(&self, check_window: bool) -> bool

Returns true if this widget is currently focused for user input.

pub fn is_default(&self) -> bool

Returns true if this widget is the target to activate when the user triggers a default action.

See MakeWidget::into_default() for more information.

pub fn is_escape(&self) -> bool

Returns true if this widget is the target to activate when the user triggers an escape action.

See MakeWidget::into_escape() for more information.

pub fn widget(&self) -> &MountedWidget

Returns the widget this context is for.

pub fn attach_styles(&self, styles: impl IntoValue<Styles>)

Attaches styles to the widget hierarchy for this widget.

Style queries for children will return any values matching this collection.

pub fn attach_theme(&self, theme: Value<ThemePair>)

Attaches theme to the widget hierarchy for this widget.

All children nodes will access this theme in their contexts.

pub fn attach_theme_mode(&self, theme_mode: Value<ThemeMode>)

Attaches theme_mode to the widget hierarchy for this widget.

All children nodes will use this theme mode.

pub fn get<Component: ComponentDefinition>( &self, query: &Component ) -> Component::ComponentType

Queries the widget hierarchy for a single style component.

This function traverses up the widget hierarchy looking for the component being requested. If a matching component is found, it will be returned. Otherwise, the default value will be returned.

pub fn try_get<Component: ComponentDefinition>( &self, query: &Component ) -> Option<Component::ComponentType>

Queries the widget hierarchy for a single style component.

This function traverses up the widget hierarchy looking for the component being requested. If a matching component is found, it will be returned.

pub fn window(&self) -> &RunningWindow<'window>

Returns the window containing this widget.

pub fn window_mut(&mut self) -> &mut RunningWindow<'window>

Returns an exclusive reference to the window containing this widget.

pub fn theme_pair(&self) -> &ThemePair

Returns the theme pair for the window.

pub fn theme(&self) -> &Theme

Returns the current theme in either light or dark mode.

pub fn inverse_theme(&self) -> &Theme

Returns the opposite theme of Self::theme().

pub fn cache_key(&self) -> WidgetCacheKey

Returns a key that can be checked to see if a widget should invalidate caches it stores.

Methods from Deref<Target = RunningWindow<'window>>

pub fn focused(&self) -> &Dynamic<bool>

Returns a dynamic that is updated whenever this window’s focus status changes.

pub fn occluded(&self) -> &Dynamic<bool>

Returns a dynamic that is updated whenever this window’s occlusion status changes.

pub fn request_close(&self)

Request that the window closes.

A window may disallow itself from being closed by customizing WindowBehavior::close_requested.

pub fn handle(&self) -> WindowHandle

Returns a handle to this window.

pub fn inner_size(&self) -> &Dynamic<Size<UPx>>

Returns a dynamic that is synchronized with this window’s inner size.

Whenever the window is resized, this dynamic will be updated with the new inner size. Setting a new value will request the new size from the operating system, but resize requests may be altered or ignored by the operating system.

pub fn clipboard_guard(&self) -> Option<MutexGuard<'_, Clipboard>>

Returns a locked mutex guard to the OS’s clipboard, if one was able to be initialized when the window opened.

Methods from Deref<Target = Window<'window, WindowCommand>>

pub fn handle(&self) -> WindowHandle<WindowEvent>

Returns a handle to this window, which can be used to send WindowEvents to it.

pub fn app(&self) -> App<AppEvent<WindowEvent>>

Returns a handle to the application.

This is useful for opening additional windows in a multi-window application.

pub fn close(&mut self)

Closes this window as soon as control returns to Kludgine.

pub fn position(&self) -> Point<Px>

Returns the current position of the window.

pub fn set_position(&self, position: Point<Px>)

Sets the current position of the window.

pub fn inner_size(&self) -> Size<UPx>

Returns the inner size of the window.

pub fn winit(&self) -> &Window

Returns a reference to the underlying winit window.

pub fn set_inner_size(&self, inner_size: Size<UPx>)

Sets the inner size of the window.

pub fn focused(&self) -> bool

Returns true if the window is currently focused for keyboard input.

pub fn theme(&self) -> Theme

Returns the current user interface theme for the window.

pub fn ocluded(&self) -> bool

Returns true if the window is currenly not visible because it is completely hidden behind other windows, offcreen, or minimized.

pub fn title(&self) -> String

Returns the current title of the window.

pub fn set_title(&mut self, new_title: &str)

Sets the title of the window.

pub fn set_ime_allowed(&self, allowed: bool)

Sets whether IME input is allowed on the window.

pub fn set_ime_purpose(&self, purpose: ImePurpose)

Sets the IME purpose.

pub fn set_ime_cursor_area(&self, area: Rect<UPx>)

Sets the cursor area for IME input suggestions.

pub fn redraw_in(&mut self, duration: Duration)

Sets the window to redraw after a duration.

If the window is already set to redraw sooner, this function does nothing.

pub fn redraw_at(&mut self, time: Instant)

Sets the window to redraw at the provided time.

If the window is already set to redraw sooner, this function does nothing.

pub fn set_needs_redraw(&mut self)

Sets the window to redraw as soon as it can.

pub fn elapsed(&self) -> Duration

Returns the duration that has elapsed since the last frame start and the current frame start.

This value is calculated once per frame and will not update between calls within the same event.

pub fn last_frame_rendered_in(&self) -> Duration

Returns the duration taken between when the last frame’s redraw started and when the surface’s frame was presented.

pub fn cursor_position(&self) -> Option<Point<Px>>

Returns the position of the mouse cursor within this window, if the cursor is currently above the window.

pub fn mouse_button_pressed(&self, button: MouseButton) -> bool

Returns true if the given button is currently pressed.

pub fn key_pressed(&self, key: impl Into<PhysicalKey>) -> bool

Returns true if the given virtual key code is currently pressed.

pub fn modifiers(&self) -> Modifiers

Returns currently active modifiers.

pub fn set_min_inner_size(&self, min_size: Option<Size<UPx>>)

Sets the window’s minimum inner size.

pub fn set_max_inner_size(&self, max_size: Option<Size<UPx>>)

Sets the window’s maximum inner size.

Trait Implementations

impl<'window> AsEventContext<'window> for GraphicsContext<'_, 'window, '_, '_, '_>

fn as_event_context(&mut self) -> EventContext<'_, 'window>

Returns this context as an EventContext.

fn push_child(&mut self, child: WidgetInstance) -> MountedWidget

Pushes a new child widget into the widget hierarchy beneathq the context’s widget.

fn remove_child(&mut self, child: &MountedWidget)

Removes a widget from the hierarchy.

impl<'context, 'window, 'clip, 'gfx, 'pass> Deref for GraphicsContext<'context, 'window, 'clip, 'gfx, 'pass>

type Target = WidgetContext<'context, 'window>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'context, 'window, 'clip, 'gfx, 'pass> DerefMut for GraphicsContext<'context, 'window, 'clip, 'gfx, 'pass>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for GraphicsContext<'_, '_, '_, '_, '_>

fn drop(&mut self)

Executes the destructor for this type.