[−][src]Struct implot::PlotFlags
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
[src]
pub const NONE: PlotFlags
[src]
"Default" according to original docs
pub const NO_LEGEND: PlotFlags
[src]
Plot items will not be highlighted when their legend entry is hovered
pub const NO_MENUS: PlotFlags
[src]
The user will not be able to open context menus with double-right click
pub const NO_BOX_SELECT: PlotFlags
[src]
The user will not be able to box-select with right-mouse
pub const NO_MOUSE_POSITION: PlotFlags
[src]
The mouse position, in plot coordinates, will not be displayed
pub const NO_HIGHLIGHT: PlotFlags
[src]
Plot items will not be highlighted when their legend entry is hovered
pub const NO_CHILD: PlotFlags
[src]
A child window region will not be used to capture mouse scroll (can boost performance for single ImGui window applications)
pub const Y_AXIS_2: PlotFlags
[src]
Enable a 2nd y axis
pub const Y_AXIS_3: PlotFlags
[src]
Enable a 3nd y axis
pub const QUERY: PlotFlags
[src]
The user will be able to draw query rects with middle-mouse
pub const CROSSHAIRS: PlotFlags
[src]
The default mouse cursor will be replaced with a crosshair when hovered
pub const ANTIALIASED: PlotFlags
[src]
Plot data outside the plot area will be culled from rendering
pub const fn empty() -> PlotFlags
[src]
Returns an empty set of flags
pub const fn all() -> PlotFlags
[src]
Returns the set containing all flags.
pub const fn bits(&self) -> u32
[src]
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u32) -> Option<PlotFlags>
[src]
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
[src]
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u32) -> PlotFlags
[src]
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn is_empty(&self) -> bool
[src]
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
[src]
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: PlotFlags) -> bool
[src]
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: PlotFlags) -> bool
[src]
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: PlotFlags)
[src]
Inserts the specified flags in-place.
pub fn remove(&mut self, other: PlotFlags)
[src]
Removes the specified flags in-place.
pub fn toggle(&mut self, other: PlotFlags)
[src]
Toggles the specified flags in-place.
pub fn set(&mut self, other: PlotFlags, value: bool)
[src]
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Binary for PlotFlags
[src]
impl BitAnd<PlotFlags> for PlotFlags
[src]
type Output = PlotFlags
The resulting type after applying the &
operator.
fn bitand(self, other: PlotFlags) -> PlotFlags
[src]
Returns the intersection between the two sets of flags.
impl BitAndAssign<PlotFlags> for PlotFlags
[src]
fn bitand_assign(&mut self, other: PlotFlags)
[src]
Disables all flags disabled in the set.
impl BitOr<PlotFlags> for PlotFlags
[src]
type Output = PlotFlags
The resulting type after applying the |
operator.
fn bitor(self, other: PlotFlags) -> PlotFlags
[src]
Returns the union of the two sets of flags.
impl BitOrAssign<PlotFlags> for PlotFlags
[src]
fn bitor_assign(&mut self, other: PlotFlags)
[src]
Adds the set of flags.
impl BitXor<PlotFlags> for PlotFlags
[src]
type Output = PlotFlags
The resulting type after applying the ^
operator.
fn bitxor(self, other: PlotFlags) -> PlotFlags
[src]
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<PlotFlags> for PlotFlags
[src]
fn bitxor_assign(&mut self, other: PlotFlags)
[src]
Toggles the set of flags.
impl Clone for PlotFlags
[src]
impl Copy for PlotFlags
[src]
impl Debug for PlotFlags
[src]
impl Eq for PlotFlags
[src]
impl Extend<PlotFlags> for PlotFlags
[src]
fn extend<T: IntoIterator<Item = PlotFlags>>(&mut self, iterator: T)
[src]
fn extend_one(&mut self, item: A)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]
impl FromIterator<PlotFlags> for PlotFlags
[src]
fn from_iter<T: IntoIterator<Item = PlotFlags>>(iterator: T) -> PlotFlags
[src]
impl Hash for PlotFlags
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl LowerHex for PlotFlags
[src]
impl Not for PlotFlags
[src]
type Output = PlotFlags
The resulting type after applying the !
operator.
fn not(self) -> PlotFlags
[src]
Returns the complement of this set of flags.
impl Octal for PlotFlags
[src]
impl Ord for PlotFlags
[src]
fn cmp(&self, other: &PlotFlags) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<PlotFlags> for PlotFlags
[src]
impl PartialOrd<PlotFlags> for PlotFlags
[src]
fn partial_cmp(&self, other: &PlotFlags) -> Option<Ordering>
[src]
fn lt(&self, other: &PlotFlags) -> bool
[src]
fn le(&self, other: &PlotFlags) -> bool
[src]
fn gt(&self, other: &PlotFlags) -> bool
[src]
fn ge(&self, other: &PlotFlags) -> bool
[src]
impl StructuralEq for PlotFlags
[src]
impl StructuralPartialEq for PlotFlags
[src]
impl Sub<PlotFlags> for PlotFlags
[src]
type Output = PlotFlags
The resulting type after applying the -
operator.
fn sub(self, other: PlotFlags) -> PlotFlags
[src]
Returns the set difference of the two sets of flags.
impl SubAssign<PlotFlags> for PlotFlags
[src]
fn sub_assign(&mut self, other: PlotFlags)
[src]
Disables all flags enabled in the set.
impl UpperHex for PlotFlags
[src]
Auto Trait Implementations
impl RefUnwindSafe for PlotFlags
impl Send for PlotFlags
impl Sync for PlotFlags
impl Unpin for PlotFlags
impl UnwindSafe for PlotFlags
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,