Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

ColorPicker

Hérite de : VBoxContainer < BoxContainer < Container < Control < CanvasItem < Node < Object

Un widget qui fournit une interface pour sélectionner ou modifier une couleur.

Description

Un widget qui fournit une interface pour sélectionner ou modifier une couleur. Il peut en option fournir des fonctionnalités comme un échantillonneur de couleur (pipette), des modes de couleur et des pré-réglages.

Note : Ce contrôle est le widget du sélecteur de couleur lui-même. Vous pouvez utiliser un ColorPickerButton au lieu de cela si vous avez besoin d'un bouton qui ouvre un ColorPicker dans une popup.

Tutoriels

Démo d'interpolation tween

Propriétés

bool	can_add_swatches	`true`
Color	color	`Color(1, 1, 1, 1)`
ColorModeType	color_mode	`0`
bool	color_modes_visible	`true`
bool	deferred_mode	`false`
bool	edit_alpha	`true`
bool	edit_intensity	`true`
bool	hex_visible	`true`
PickerShapeType	picker_shape	`0`
bool	presets_visible	`true`
bool	sampler_visible	`true`
bool	sliders_visible	`true`

Méthodes

void	add_preset(color: Color)
void	add_recent_preset(color: Color)
void	erase_preset(color: Color)
void	erase_recent_preset(color: Color)
PackedColorArray	get_presets() const
PackedColorArray	get_recent_presets() const

Propriétés du thème

Color	focused_not_editing_cursor_color	`Color(1, 1, 1, 0.275)`
int	center_slider_grabbers	`1`
int	h_width	`30`
int	label_width	`10`
int	margin	`4`
int	sv_height	`256`
int	sv_width	`256`
Texture2D	add_preset
Texture2D	bar_arrow
Texture2D	color_copy
Texture2D	color_hue
Texture2D	color_script
Texture2D	expanded_arrow
Texture2D	folded_arrow
Texture2D	menu_option
Texture2D	overbright_indicator
Texture2D	picker_cursor
Texture2D	picker_cursor_bg
Texture2D	sample_bg
Texture2D	sample_revert
Texture2D	screen_picker
Texture2D	shape_circle
Texture2D	shape_rect
Texture2D	shape_rect_wheel
StyleBox	picker_focus_circle
StyleBox	picker_focus_rectangle
StyleBox	sample_focus

Signaux

color_changed(color: Color) 🔗

Émis lorsque la couleur est changée.

preset_added(color: Color) 🔗

Émis lors de l'ajout d'un préréglage.

preset_removed(color: Color) 🔗

Émis lorsqu’un préréglage est supprimé.

Énumérations

enum ColorModeType: 🔗

ColorModeType MODE_RGB = 0

Permet d'éditer la couleur avec les sliders Rouge/Vert/Bleu dans l'espace de couleur sRGB.

ColorModeType MODE_HSV = 1

Permet d'éditer la couleur avec des sliders Teinte/Saturation/Luminosité (Hue, Saturation, Lightness).

ColorModeType MODE_RAW = 2

Obsolète : This is replaced by MODE_LINEAR.

ColorModeType MODE_LINEAR = 2

Permet d'éditer la couleur avec des sliders Rouge/Vert/Bleu dans l'espace de couleur linéaire.

ColorModeType MODE_OKHSL = 3

Permet d'éditer la couleur avec les sliders Teinte/Saturation/Luminosité.

OK TSL est un nouvel espace de couleur semblable à TSL mais qui correspond mieux à la perception en utilisant l'espace de couleur Oklab qui est conçu pour être simple à utiliser, tout en faisant un bon travail pour prédire la luminosité, saturation et teinte perçues.

Espaces de couleur Oktsv et Oktsl

enum PickerShapeType: 🔗

PickerShapeType SHAPE_HSV_RECTANGLE = 0

Espace de couleur rectangulaire Modèle de couleur TSV.

PickerShapeType SHAPE_HSV_WHEEL = 1

Espace de couleur rectangulaire Modèle de couleur TSV avec une roue.

PickerShapeType SHAPE_VHS_CIRCLE = 2

Espace de couleur circulaire Modèle de couleur TSV. Utilise la saturation comme rayon.

PickerShapeType SHAPE_OKHSL_CIRCLE = 3

Espace de couleur circulaire Modèle de couleur TSL OK.

PickerShapeType SHAPE_NONE = 4

La forme de l'espace de couleur et le bouton de sélection de forme sont cachés. Ne peut pas être sélectionné parmi le popup des formes.

PickerShapeType SHAPE_OK_HS_RECTANGLE = 5

Rectangle de Modèle de couleur OKHSL avec une luminosité constante.

PickerShapeType SHAPE_OK_HL_RECTANGLE = 6

Rectangle de Modèle de couleur OKHSL avec une saturation constante.

Descriptions des propriétés

bool can_add_swatches = true 🔗

void set_can_add_swatches(value: bool)
bool are_swatches_enabled()

Si true, il est possible d'ajouter des préréglages sous Nuanciers. Si false, le bouton pour ajouter des préréglages est désactivé.

Color color = Color(1, 1, 1, 1) 🔗

void set_pick_color(value: Color)
Color get_pick_color()

La couleur actuellement sélectionnée.

ColorModeType color_mode = 0 🔗

void set_color_mode(value: ColorModeType)
ColorModeType get_color_mode()

Le mode de couleur actuellement sélectionné.

bool color_modes_visible = true 🔗

void set_modes_visible(value: bool)
bool are_modes_visible()

Si true, les boutons de mode de couleur sont visibles.

bool deferred_mode = false 🔗

void set_deferred_mode(value: bool)
bool is_deferred_mode()

Si true, la couleur ne s'appliquera que quand l'utilisateur relâche le bouton de la souris, sinon elle s'appliquera immédiatement en suivant le déplacement de la souris (ce qui peut causer des problèmes de performance).

bool edit_alpha = true 🔗

void set_edit_alpha(value: bool)
bool is_editing_alpha()

Si true, affiche un slider de canal alpha (opacité).

bool edit_intensity = true 🔗

void set_edit_intensity(value: bool)
bool is_editing_intensity()

Si true, affiche un slider d'intensité. L'intensité est appliquée comme suit : convertir la couleur en encodage linéaire, multiplier la couleur par 2 ** intensité, puis la re-convertir en encodage sRGB non-linéaire.

bool hex_visible = true 🔗

void set_hex_visible(value: bool)
bool is_hex_visible()

Si true, le champ de saisie du code de couleur hexadécimal est visible.

PickerShapeType picker_shape = 0 🔗

void set_picker_shape(value: PickerShapeType)
PickerShapeType get_picker_shape()

La forme de la vue de l'espace de couleur.

bool presets_visible = true 🔗

void set_presets_visible(value: bool)
bool are_presets_visible()

Si true, les préréglages de nuanciers et de couleurs récentes sont visibles.

bool sampler_visible = true 🔗

void set_sampler_visible(value: bool)
bool is_sampler_visible()

Si true, l’échantillonneur de couleur et la prévisualisation de la couleur sont visibles.

bool sliders_visible = true 🔗

void set_sliders_visible(value: bool)
bool are_sliders_visible()

Si true, les sliders de couleurs sont visibles.

Descriptions des méthodes

void add_preset(color: Color) 🔗

Ajoute la couleur donnée à une liste de pré-réglages de couleur. Les pré-réglages sont affichés dans le sélecteur de couleurs que l'utilisateur pourra sélectionner.

Note : La liste des pré-réglages est seulement pour ce sélecteur de couleur.

void add_recent_preset(color: Color) 🔗

Ajoute la couleur donnée à une liste de pré-réglages de couleur récents qui peuvent être re-sélectionnés plus tard. Les pré-réglages récents sont les couleurs qui ont été choisies récemment, un nouveau pré-réglage est automatiquement créé et ajouté aux pré-réglages récents quand vous choisissez une nouvelle couleur.

Note : La liste des pré-réglages récents est seulement pour ce sélecteur de couleur.

void erase_preset(color: Color) 🔗

Retire la couleur donnée de la liste des pré-réglages de couleur de ce sélecteur de couleur.

void erase_recent_preset(color: Color) 🔗

Retire la couleur donnée de la liste des pré-réglages de couleur récents de ce sélecteur de couleur.

PackedColorArray get_presets() const 🔗

Renvoie la liste des couleurs dans la palette du sélecteur de couleur.

PackedColorArray get_recent_presets() const 🔗

Renvoie la liste des couleurs dans les pré-réglages récents du sélecteur de couleur.

Descriptions des propriétés du thème

Color focused_not_editing_cursor_color = Color(1, 1, 1, 0.275) 🔗

Couleur du rectangle ou du cercle dessiné quand une partie de la forme du sélecteur a le focus mais est non modifiable via le clavier ou la manette. Affiché par-dessus la forme du sélecteur, donc une couleur partiellement transparente doit être utilisée pour s'assurer que la forme du sélecteur reste visible.

int center_slider_grabbers = 1 🔗

Redéfinit la propriété de thème Slider.center_grabber des sliders.

int h_width = 30 🔗

La largeur de glisseur de la teinte.

int label_width = 10 🔗

La largeur minimale des étiquettes de couleur à côté des sliders.

int margin = 4 🔗

La marge autour du ColorPicker.

int sv_height = 256 🔗

La hauteur de la boite de sélection de la saturation.

int sv_width = 256 🔗

La largeur de la boite de sélection de la saturation.

Texture2D add_preset 🔗

L'icône du bouton pour ajouter un préréglage.

Texture2D bar_arrow 🔗

La texture pour l’ascenseur en forme de flèche.

Texture2D color_copy 🔗

The icon for the button that copies the color in text format to the clipboard.

Texture2D color_hue 🔗

La texture personnalisée pour le glisseur de sélection de la teinte sur la droite.

Texture2D color_script 🔗

L'icône pour le bouton qui change le texte de la couleur en hexadécimal.

Texture2D expanded_arrow 🔗

L'icône pour le menu déroulant des préréglages de couleur lorsqu'étendu.

Texture2D folded_arrow 🔗

L'icône pour le menu déroulant des préréglages de couleur lorsque replié.

L'icône pour le menu des options des préréglages de couleur.

Texture2D overbright_indicator 🔗

L'indicateur utilisé pour signaler que la valeur de couleur est en dehors de l'intervalle 0-1.

Texture2D picker_cursor 🔗

L'image affichée sur la boîte/cercle de couleur (selon picker_shape), marquant la couleur actuellement sélectionnée.

Texture2D picker_cursor_bg 🔗

L'image de remplissage affichée derrière le curseur du sélecteur.

Texture2D sample_bg 🔗

Panneau d'arrière-plan pour la boîte de prévisualisation des couleurs (visible lorsque la couleur est translucide).

Texture2D sample_revert 🔗

L'icône pour le bouton de rétablissement (visible au milieu de l' "ancienne" couleur quand elle diffère de la couleur actuellement sélectionnée). Cette icône est modulée avec une couleur foncée si l'"ancienne" couleur est assez lumineuse, de sorte que l'icône devrait être lumineuse pour assurer la visibilité dans les deux scénarios.

Texture2D screen_picker 🔗

L'icône pour le bouton de sélecteur de couleur d'écran.

Texture2D shape_circle 🔗

L'icône pour les formes de sélecteur circulaire.

Texture2D shape_rect 🔗

L'icône pour les formes de sélecteur rectangulaire.

Texture2D shape_rect_wheel 🔗

L'icône pour les formes de sélecteur en roue rectangulaire.

StyleBox picker_focus_circle 🔗

La StyleBox utilisée lorsque la partie en forme de cercle du sélecteur a le focus. S'affiche par-dessus la forme du sélecteur, donc une StyleBox partiellement transparente devrait être utilisée pour s'assurer que la forme du sélecteur reste visible. Une StyleBox qui représente un contour ou un soulignement fonctionne bien à cette fin. Pour désactiver l'effet visuel de focus, assignez une ressource StyleBoxEmpty. Notez que la désactivation de l'effet visuel de focus va nuire à l'utilisabilité de la navigation clavier/contrôleur, ce qui n'est donc pas recommandé pour des raisons d'accessibilité.

StyleBox picker_focus_rectangle 🔗

La StyleBox utilisée lorsque la partie en forme de rectangle du sélecteur a le focus. S'affiche par-dessus la forme du sélecteur, donc une StyleBox partiellement transparente devrait être utilisée pour s'assurer que la forme du sélecteur reste visible. Une StyleBox qui représente un contour ou un soulignement fonctionne bien à cette fin. Pour désactiver l'effet visuel de focus, assignez une ressource StyleBoxEmpty. Notez que la désactivation de l'effet visuel de focus va nuire à l'utilisabilité de la navigation clavier/contrôleur, ce qui n'est donc pas recommandé pour des raisons d'accessibilité.

StyleBox sample_focus 🔗

La StyleBox utilisée lorsque la partie de l'ancien échantillon lorsqu'il a le focus. S'affiche par-dessus la forme du sélecteur, donc une StyleBox partiellement transparente devrait être utilisée pour s'assurer que la forme du sélecteur reste visible. Une StyleBox qui représente un contour ou un soulignement fonctionne bien à cette fin. Pour désactiver l'effet visuel de focus, assignez une ressource StyleBoxEmpty. Notez que la désactivation de l'effet visuel de focus va nuire à l'utilisabilité de la navigation clavier/contrôleur, ce qui n'est donc pas recommandé pour des raisons d'accessibilité.