Struct imgui::ColorEdit

pub struct ColorEdit<'a, T: AsRef<str> + 'a> { /* fields omitted */ }

Builder for a color editor widget.

Examples

let ce = ColorEdit::new(im_str!("color_edit"), &mut color);
if ce.build(&ui) {
  println!("The color was changed");
}

Implementations

impl<'a, T: AsRef<str> + 'a> ColorEdit<'a, T>

pub fn new(label: T, value: impl Into<EditableColor<'a>>) -> ColorEdit<'a, T>

Constructs a new color editor builder.

pub fn flags(self, flags: ColorEditFlags) -> Self

Replaces all current settings with the given flags.

pub fn alpha(self, value: bool) -> Self

Enables/disables the use of the alpha component.

pub fn picker(self, value: bool) -> Self

Enables/disables the picker that appears when clicking on colored square.

pub fn options(self, value: bool) -> Self

Enables/disables toggling of the options menu when right-clicking on inputs or the small preview.

pub fn small_preview(self, value: bool) -> Self

Enables/disables the colored square preview next to the inputs.

pub fn inputs(self, value: bool) -> Self

Enables/disables the input sliders/text widgets.

pub fn tooltip(self, value: bool) -> Self

Enables/disables the tooltip that appears when hovering the preview.

pub fn label(self, value: bool) -> Self

Enables/disables display of the inline text label (the label is in any case forwarded to the tooltip and picker).

pub fn alpha_bar(self, value: bool) -> Self

Enables/disables the vertical alpha bar/gradient in the color picker.

pub fn preview(self, preview: ColorPreview) -> Self

Sets the preview style.

pub fn hdr(self, value: bool) -> Self

(WIP) Currently only disables 0.0..1.0 limits in RGBA edition.

Note: you probably want to use ColorFormat::Float as well.

pub fn input_mode(self, input_mode: ColorEditInputMode) -> Self

Sets the data format for input and output data.

pub fn display_mode(self, mode: ColorEditDisplayMode) -> Self

Sets the color editor display mode.

pub fn format(self, format: ColorFormat) -> Self

Sets the formatting style of color components.

pub fn build(self, ui: &Ui<'_>) -> bool

Builds the color editor.

Returns true if the color value was changed.

Trait Implementations

impl<'a, T: Debug + AsRef<str> + 'a> Debug for ColorEdit<'a, T>

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

Formats the value using the given formatter.