Struct gdnative::api::ColorPicker

pub struct ColorPicker { /* fields omitted */ }

core class ColorPicker inherits BoxContainer (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

ColorPicker is a reference-only type. Persistent references can only exist in the unsafe Ref<ColorPicker> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

ColorPicker inherits methods from:

• BoxContainer
• Container
• Control
• CanvasItem
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl ColorPicker

pub fn new() -> Ref<ColorPicker, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn add_preset(&self, color: Color)

Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them.
				[b]Note:[/b] the presets list is only for [i]this[/i] color picker.

pub fn are_presets_enabled(&self) -> bool

If [code]true[/code], the "add preset" button is enabled.

pub fn are_presets_visible(&self) -> bool

If [code]true[/code], saved color presets are visible.

pub fn erase_preset(&self, color: Color)

Removes the given color from the list of color presets of this color picker.

pub fn pick_color(&self) -> Color

The currently selected color.

pub fn get_presets(&self) -> TypedArray<Color>

Returns the list of colors in the presets of the color picker.

pub fn is_deferred_mode(&self) -> bool

If [code]true[/code], the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).

pub fn is_editing_alpha(&self) -> bool

If [code]true[/code], shows an alpha channel slider (transparency).

pub fn is_hsv_mode(&self) -> bool

If [code]true[/code], allows editing the color with Hue/Saturation/Value sliders.
			[b]Note:[/b] Cannot be enabled if raw mode is on.

pub fn is_raw_mode(&self) -> bool

If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
			[b]Note:[/b] Cannot be enabled if HSV mode is on.

pub fn set_deferred_mode(&self, mode: bool)

If [code]true[/code], the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).

pub fn set_edit_alpha(&self, show: bool)

If [code]true[/code], shows an alpha channel slider (transparency).

pub fn set_hsv_mode(&self, mode: bool)

If [code]true[/code], allows editing the color with Hue/Saturation/Value sliders.
			[b]Note:[/b] Cannot be enabled if raw mode is on.

pub fn set_pick_color(&self, color: Color)

The currently selected color.

pub fn set_presets_enabled(&self, enabled: bool)

If [code]true[/code], the "add preset" button is enabled.

pub fn set_presets_visible(&self, visible: bool)

If [code]true[/code], saved color presets are visible.

pub fn set_raw_mode(&self, mode: bool)

If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
			[b]Note:[/b] Cannot be enabled if HSV mode is on.

Methods from Deref<Target = BoxContainer>

pub const ALIGN_BEGIN: i64

pub const ALIGN_CENTER: i64

pub const ALIGN_END: i64

pub fn add_spacer(&self, begin: bool)

Adds a control to the box as a spacer. If [code]true[/code], [code]begin[/code] will insert the spacer control in front of other children.

pub fn alignment(&self) -> AlignMode

The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]).

pub fn set_alignment(&self, alignment: i64)

The alignment of the container's children (must be one of [constant ALIGN_BEGIN], [constant ALIGN_CENTER] or [constant ALIGN_END]).

Trait Implementations

impl Debug for ColorPicker

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

Formats the value using the given formatter.

impl Deref for ColorPicker

type Target = BoxContainer

The resulting type after dereferencing.

fn deref(&self) -> &BoxContainer

Dereferences the value.

impl DerefMut for ColorPicker

fn deref_mut(&mut self) -> &mut BoxContainer

Mutably dereferences the value.

impl GodotObject for ColorPicker

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for ColorPicker

fn construct() -> Ref<ColorPicker, Unique>

impl QueueFree for ColorPicker

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<BoxContainer> for ColorPicker

impl SubClass<CanvasItem> for ColorPicker

impl SubClass<Container> for ColorPicker

impl SubClass<Control> for ColorPicker

impl SubClass<Node> for ColorPicker

impl SubClass<Object> for ColorPicker