Struct implot::PlotFlags

#[repr(transparent)]pub struct PlotFlags { /* fields omitted */ }

Flags for customizing plot behavior and interaction. Documentation copied from implot.h for convenience. ImPlot itself also has a "CanvasOnly" flag, which can be emulated here with the combination of NO_LEGEND, NO_MENUS, NO_BOX_SELECT and NO_MOUSE_POSITION.

Implementations

impl PlotFlags

pub const NONE: PlotFlags

"Default" according to original docs

pub const NO_LEGEND: PlotFlags

Plot items will not be highlighted when their legend entry is hovered

pub const NO_MENUS: PlotFlags

The user will not be able to open context menus with double-right click

pub const NO_BOX_SELECT: PlotFlags

The user will not be able to box-select with right-mouse

pub const NO_MOUSE_POSITION: PlotFlags

The mouse position, in plot coordinates, will not be displayed

pub const NO_HIGHLIGHT: PlotFlags

Plot items will not be highlighted when their legend entry is hovered

pub const NO_CHILD: PlotFlags

A child window region will not be used to capture mouse scroll (can boost performance for single ImGui window applications)

pub const AXIS_EQUAL: PlotFlags

Use an aspect ratio of 1:1 for the plot

pub const Y_AXIS_2: PlotFlags

Enable a 2nd y axis

pub const Y_AXIS_3: PlotFlags

Enable a 3nd y axis

pub const QUERY: PlotFlags

The user will be able to draw query rects with middle-mouse

pub const CROSSHAIRS: PlotFlags

The default mouse cursor will be replaced with a crosshair when hovered

pub const ANTIALIASED: PlotFlags

Plot data outside the plot area will be culled from rendering

pub const fn empty() -> PlotFlags

Returns an empty set of flags

pub const fn all() -> PlotFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<PlotFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> PlotFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> PlotFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: PlotFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: PlotFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: PlotFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: PlotFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: PlotFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: PlotFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for PlotFlags

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

Formats the value using the given formatter.

impl BitAnd<PlotFlags> for PlotFlags

type Output = PlotFlags

The resulting type after applying the & operator.

fn bitand(self, other: PlotFlags) -> PlotFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<PlotFlags> for PlotFlags

fn bitand_assign(&mut self, other: PlotFlags)

Disables all flags disabled in the set.

impl BitOr<PlotFlags> for PlotFlags

type Output = PlotFlags

The resulting type after applying the | operator.

fn bitor(self, other: PlotFlags) -> PlotFlags

Returns the union of the two sets of flags.

impl BitOrAssign<PlotFlags> for PlotFlags

fn bitor_assign(&mut self, other: PlotFlags)

Adds the set of flags.

impl BitXor<PlotFlags> for PlotFlags

type Output = PlotFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: PlotFlags) -> PlotFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<PlotFlags> for PlotFlags

fn bitxor_assign(&mut self, other: PlotFlags)

Toggles the set of flags.

impl Clone for PlotFlags

fn clone(&self) -> PlotFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PlotFlags

impl Debug for PlotFlags

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

Formats the value using the given formatter.

impl Eq for PlotFlags

impl Extend<PlotFlags> for PlotFlags

fn extend<T: IntoIterator<Item = PlotFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<PlotFlags> for PlotFlags

fn from_iter<T: IntoIterator<Item = PlotFlags>>(iterator: T) -> PlotFlags

Creates a value from an iterator.

impl Hash for PlotFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for PlotFlags

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

Formats the value using the given formatter.

impl Not for PlotFlags

type Output = PlotFlags

The resulting type after applying the ! operator.

fn not(self) -> PlotFlags

Returns the complement of this set of flags.

impl Octal for PlotFlags

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

Formats the value using the given formatter.

impl Ord for PlotFlags

fn cmp(&self, other: &PlotFlags) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PlotFlags> for PlotFlags

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

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

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

This method tests for !=.

impl PartialOrd<PlotFlags> for PlotFlags

fn partial_cmp(&self, other: &PlotFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &PlotFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &PlotFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &PlotFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &PlotFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for PlotFlags

impl StructuralPartialEq for PlotFlags

impl Sub<PlotFlags> for PlotFlags

type Output = PlotFlags

The resulting type after applying the - operator.

fn sub(self, other: PlotFlags) -> PlotFlags

Returns the set difference of the two sets of flags.

impl SubAssign<PlotFlags> for PlotFlags

fn sub_assign(&mut self, other: PlotFlags)

Disables all flags enabled in the set.

impl UpperHex for PlotFlags

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

Formats the value using the given formatter.