This is a class for storing part of the DebugDraw3D configuration. More...

#include <config_3d.h>

Inheritance diagram for DebugDraw3DConfig:

Public Types
enum	CullingMode : uint32_t { FRUSTUM_DISABLED , FRUSTUM_ROUGH , FRUSTUM_PRECISE }

Public Member Functions
NAPI void	set_freeze_3d_render (const bool &_state)
NAPI bool	is_freeze_3d_render () const
NAPI void	set_visible_instance_bounds (const bool &_state)
NAPI bool	is_visible_instance_bounds () const
NAPI void	set_use_frustum_culling (const bool &_state)
NAPI bool	is_use_frustum_culling () const
NAPI void	set_frustum_culling_mode (const DebugDraw3DConfig::CullingMode _mode)
NAPI DebugDraw3DConfig::CullingMode	get_frustum_culling_mode () const
NAPI void	set_frustum_length_scale (const real_t &_distance)
NAPI real_t	get_frustum_length_scale () const
NAPI void	set_force_use_camera_from_scene (const bool &_state)
NAPI bool	is_force_use_camera_from_scene () const
NAPI void	set_geometry_render_layers (const int32_t &_layers)
NAPI int32_t	get_geometry_render_layers () const
NAPI void	set_line_hit_color (const godot::Color &_new_color)
NAPI godot::Color	get_line_hit_color () const
NAPI void	set_line_after_hit_color (const godot::Color &_new_color)
NAPI godot::Color	get_line_after_hit_color () const

Detailed Description

This is a class for storing part of the DebugDraw3D configuration.

You can use DebugDraw3D.get_config to get the current instance of the configuration.

Member Enumeration Documentation

◆ CullingMode

enum DebugDraw3DConfig::CullingMode : uint32_t

Frustum culling mode. You can disable it completely or select the culling accuracy.

Member Function Documentation

◆ set_freeze_3d_render()

NAPI void DebugDraw3DConfig::set_freeze_3d_render ( const bool & _state )

Set whether debug 3D graphics rendering is frozen. This means that previously created geometry will not be updated until set to false or until DebugDraw3D.clear_all is called.

◆ set_visible_instance_bounds()

NAPI void DebugDraw3DConfig::set_visible_instance_bounds ( const bool & _state )

Set whether the boundaries of instances are displayed. Based on these boundaries, instances are culled if set_use_frustum_culling is activated.

◆ set_use_frustum_culling()

NAPI void DebugDraw3DConfig::set_use_frustum_culling ( const bool & _state )

Deprecated: Set whether frustum culling is used. This is a wrapper over DebugDraw3DConfig.set_frustum_culling_mode and exists for compatibility with older versions.

Note: Enabling or disabling this option does not affect the rough culling based on the camera's AABB of frustum. This option enables more accurate culling based on the camera's frustum planes.

◆ set_frustum_culling_mode()

NAPI void DebugDraw3DConfig::set_frustum_culling_mode ( const DebugDraw3DConfig::CullingMode _mode )

Set frustum culling mode.

◆ set_frustum_length_scale()

NAPI void DebugDraw3DConfig::set_frustum_length_scale ( const real_t & _distance )

Change the distance between the Far and Near Planes of the Viewport's Camera3D.

◆ set_force_use_camera_from_scene()

NAPI void DebugDraw3DConfig::set_force_use_camera_from_scene ( const bool & _state )

Set the forced use of the scene camera instead of the editor camera.

◆ set_geometry_render_layers()

NAPI void DebugDraw3DConfig::set_geometry_render_layers ( const int32_t & _layers )

Set the visibility layer on which the 3D geometry will be drawn. Similar to using VisualInstance3D.layers.

◆ set_line_hit_color()

NAPI void DebugDraw3DConfig::set_line_hit_color ( const godot::Color & _new_color )

Set the default color for the collision point of DebugDraw3D.draw_line_hit.

◆ set_line_after_hit_color()

NAPI void DebugDraw3DConfig::set_line_after_hit_color ( const godot::Color & _new_color )

Set the default color for the line after the collision point of DebugDraw3D.draw_line_hit.

The documentation for this class was generated from the following file:

src/3d/config_3d.h

Public Types

Public Member Functions