Struct mooeye::ui::UiDrawParam

pub struct UiDrawParam {
    pub target: Rect,
    pub mouse_listen: bool,
    pub param: DrawParam,
}

An extension of the ggez::graphics::DrawParam struct specifically for UiElements.

Fields

target: Rect

The rectangular target area this element shall be drawn to.

mouse_listen: bool

Wether or not the element should listen to the mouse position and possible change its visuals or display a tooltip when hovered over.

param: DrawParam

A basic draw param struct to manage things like z-level, color and src-rect. Setting dest_rect may yield unexpected behaviour, as it will likely be overwritten by target when drawing.

Implementations

impl UiDrawParam

pub fn new() -> Self

Creates a new UiDrawParam with default values.

pub fn target(self, target: Rect) -> Self

Returns a new UiDrawParam with the specified target area.

pub fn mouse_listen(self, mouse_listen: bool) -> Self

Returns a new UiDrawParam with the specified mouse_listen value.

pub fn z_level(self, z_level: i32) -> Self

Returns a new UiDrawParam with only the z value of the contained param set to the specified value.

pub fn param(self, param: DrawParam) -> Self

Returns a new UiDrawParam with the entire DrawParam replaced by the specified value.

Trait Implementations

impl Clone for UiDrawParam

fn clone(&self) -> UiDrawParam

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UiDrawParam

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UiDrawParam

fn default() -> UiDrawParam

Returns the “default value” for a type.

impl From<DrawParam> for UiDrawParam

fn from(value: DrawParam) -> Self

Converts to this type from the input type.

impl From<UiDrawParam> for DrawParam

fn from(value: UiDrawParam) -> Self

Converts to this type from the input type.

impl PartialEq<UiDrawParam> for UiDrawParam

fn eq(&self, other: &UiDrawParam) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for UiDrawParam

impl StructuralPartialEq for UiDrawParam