Struct bevy_rapier2d::render::RapierDebugRenderPlugin

pub struct RapierDebugRenderPlugin {
    pub always_on_top: bool,
    pub enabled: bool,
    pub style: DebugRenderStyle,
    pub mode: DebugRenderMode,
}

Plugin rensponsible for rendering (using lines) what Rapier “sees” when performing its physics simulation. This is typically useful to check proper alignment between colliders and your own visual assets.

Fields

always_on_top: bool

If set to true, depth-testing will be disabled when rendering, meaning that the debug-render lines will always appear on top of (won’t be occluded by) your own visual assets.

enabled: bool

Is the debug-rendering enabled?

style: DebugRenderStyle

Control some aspects of the render coloring.

mode: DebugRenderMode

Flags to select what part of physics scene is rendered (by default everything is rendered).

Implementations

impl RapierDebugRenderPlugin

pub fn always_on_top(self) -> Self

Initialize the render plugin such that its lines are always rendered on top of other objects.

pub fn disabled(self) -> Self

Initialize the render plugin such that it is initially disabled.

Trait Implementations

impl Default for RapierDebugRenderPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for RapierDebugRenderPlugin

fn build(&self, app: &mut App)

Configures the [App] to which this plugin is added.

fn setup(&self, _app: &mut App)

Runs after all plugins are built, but before the app runner is called. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the [Plugin] which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.