Struct basalt::input::builder::InputCursorBuilder

pub struct InputCursorBuilder<'a> { /* private fields */ }

Builder returned by on_cursor.

Implementations

impl<'a> InputCursorBuilder<'a>

pub fn weight(self, weight: i16) -> Self

Assigns a weight.

Notes

• Higher weights get called first and may not pass events.

pub fn require_on_top(self, top: bool) -> Self

Require the target to be the top-most.

Default: false

Notes

• This has no effect on Window targets.

pub fn require_focused(self, focus: bool) -> Self

Require the target to be focused.

Default: false

pub fn call<F: FnMut(InputHookTarget, &WindowState, &LocalCursorState) -> InputHookCtrl + Send + 'static>(
    self,
    method: F
) -> Self

Assign a function to call.

Notes

• Calling this multiple times will not add additional methods.

pub fn finish(self) -> Result<InputHookID, InputError>

Finish building, validate, and submit it to Input.

Possible Errors

• NoMethod: No method was added. See call.
• NoTarget: No call to bin() or window() was made.