Singleton class for calling debugging 2D methods. More...

#include <debug_draw_2d.h>

Inheritance diagram for DebugDraw2D:

Public Member Functions
Color	get_empty_color () const

void	set_debug_enabled (const bool &_state)

bool	is_debug_enabled () const

void	set_config (Ref< DebugDraw2DConfig > _cfg)

Ref< DebugDraw2DConfig >	get_config () const

void	set_custom_canvas (Control *_canvas)

Control *	get_custom_canvas () const

Ref< DebugDraw2DStats >	get_render_stats ()

void	clear_all ()

void	begin_text_group (String group_title, int group_priority=0, Color group_color=Colors::white_smoke, bool show_title=true, int title_size=14, int text_size=12)

void	end_text_group ()

void	set_text (String key, Variant value=Variant(), int priority=0, Color color_of_value=Colors::empty_color, real_t duration=-1)

void	clear_texts ()

Static Public Member Functions
static DebugDraw2D *	get_singleton ()

Detailed Description

Singleton class for calling debugging 2D methods.

Currently, this class supports drawing an overlay with text.

Member Function Documentation

◆ get_singleton()

static DebugDraw2D * DebugDraw2D::get_singleton ( )

inlinestatic

Get singleton. Not available in GDScript.

◆ get_empty_color()

Color DebugDraw2D::get_empty_color ( ) const

Get the color that is used as the default parameter for draw_* calls.

◆ set_debug_enabled()

void DebugDraw2D::set_debug_enabled ( const bool & _state )

Set whether debug drawing works or not.

◆ set_config()

void DebugDraw2D::set_config ( Ref< DebugDraw2DConfig > _cfg )

Set the configuration global for everything in DebugDraw2D.

◆ get_config()

Ref< DebugDraw2DConfig > DebugDraw2D::get_config ( ) const

Get the DebugDraw2DConfig.

◆ set_custom_canvas()

void DebugDraw2D::set_custom_canvas ( Control * _canvas )

Set a custom Control to be used as the canvas for drawing the graphic.

You can use any Control, even one that is in a different window.

◆ get_render_stats()

Ref< DebugDraw2DStats > DebugDraw2D::get_render_stats ( )

Returns the DebugDraw2DStats instance with the current statistics.

Some data can be delayed by 1 frame.

◆ clear_all()

void DebugDraw2D::clear_all ( )

Clear all 2D objects

◆ begin_text_group()

void DebugDraw2D::begin_text_group	(	String	group_title,
		int	group_priority = 0,
		Color	group_color = Colors::white_smoke,
		bool	show_title = true,
		int	title_size = 14,
		int	text_size = 12 )

Begin a text group to which all of the following text from DebugDraw2D.set_text will be added

Parameters

group_title	Group title and ID
group_priority	Group priority based on which groups will be sorted from top to bottom.
group_color	Main color of the group
show_title	Whether to show the title
title_size	Title font size
text_size	Text font size

◆ end_text_group()

void DebugDraw2D::end_text_group ( )

Ends the text group. Should be called after DebugDraw2D.begin_text_group.

If you need to create multiple groups, just call DebugDraw2D.begin_text_group again and this function at the end.

◆ set_text()

void DebugDraw2D::set_text	(	String	key,
		Variant	value = Variant(),
		int	priority = 0,
		Color	color_of_value = Colors::empty_color,
		real_t	duration = -1 )

Add or update text in an overlay