Class ImmediateDebugRenderFeature

Namespace

Stride.CommunityToolkit.DebugShapes

Assembly

Stride.CommunityToolkit.DebugShapes.dll

Provides functionality for rendering immediate debug primitives such as lines, shapes, and other geometric objects.

public class ImmediateDebugRenderFeature : RootRenderFeature, IComponent, IReferencable, ICollectorHolder, IGraphicsRendererCore, IDisposable

Inheritance

object

DisposeBase

ComponentBase

RenderFeature

RootRenderFeature

ImmediateDebugRenderFeature

Implements

IComponent

IReferencable

ICollectorHolder

IGraphicsRendererCore

IDisposable

Inherited Members

RootRenderFeature.RenderData

RootRenderFeature.RenderObjects

RootRenderFeature.GetRenderNode(RenderNodeReference)

RootRenderFeature.GetViewObjectNode(ViewObjectNodeReference)

RootRenderFeature.GetObjectNode(ObjectNodeReference)

RootRenderFeature.CreateViewObjectNode(RenderView, RenderObject)

RootRenderFeature.OnAddRenderObject(RenderObject)

RootRenderFeature.OnRemoveRenderObject(RenderObject)

RootRenderFeature.Reset()

RootRenderFeature.PrepareDataArrays()

RootRenderFeature.ComputeDataArrayExpectedSize(DataType)

RootRenderFeature.BindPerViewShaderResource(string, RenderView, GraphicsResource)

RootRenderFeature.Index

RootRenderFeature.SortKey

RootRenderFeature.ObjectNodeReferences

RootRenderFeature.RenderNodes

RootRenderFeature.RenderStageSelectors

RenderFeature.Initialize(RenderContext)

RenderFeature.Destroy()

RenderFeature.Collect()

RenderFeature.PrepareEffectPermutations(RenderDrawContext)

RenderFeature.Draw(RenderDrawContext, RenderView, RenderViewStage)

RenderFeature.OnRenderSystemChanged()

RenderFeature.Context

RenderFeature.RenderSystem

RenderFeature.Initialized

RenderFeature.Enabled

ComponentBase.Tags

ComponentBase.OnNameChanged()

ComponentBase.ToString()

ComponentBase.Name

DisposeBase.Dispose()

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

DisposeBase.IsDisposed

Remarks

This class is designed to render debug primitives directly to the screen, bypassing typical rendering pipelines. It supports various geometric shapes, including quads, circles, spheres, cubes, capsules, cylinders, cones, and lines. The rendering process is optimized for debugging purposes, allowing developers to visualize objects in real-time.

Constructors

ImmediateDebugRenderFeature()

Initializes a new instance of the ImmediateDebugRenderFeature class.

public ImmediateDebugRenderFeature()

Remarks

This constructor sets the default sort key to ensure that the feature is rendered last, preventing background elements from being rendered over objects without depth testing in the opaque stage.

Fields

ProfilingKey

The block the profiler shows this feature's GPU time under.

public static readonly ProfilingKey ProfilingKey

Field Value

ProfilingKey

Properties

SupportedRenderObjectType

public override Type SupportedRenderObjectType { get; }

Property Value

Type

Methods

Draw(RenderDrawContext, RenderView, RenderViewStage, int, int)

public override void Draw(RenderDrawContext context, RenderView renderView, RenderViewStage renderViewStage, int startIndex, int endIndex)

Parameters

context RenderDrawContext

renderView RenderView

renderViewStage RenderViewStage

startIndex int

endIndex int

Extract()

public override void Extract()

Flush(RenderDrawContext)

public override void Flush(RenderDrawContext context)

Parameters

context RenderDrawContext

InitializeCore()

protected override void InitializeCore()

Prepare(RenderDrawContext)

public override void Prepare(RenderDrawContext context)

Parameters

context RenderDrawContext

Unload()

public override void Unload()