Class ImmediateDebugRenderObject

Namespace

Stride.CommunityToolkit.DebugShapes

Assembly

Stride.CommunityToolkit.DebugShapes.dll

Represents a render object for immediate debug rendering, allowing the addition of various shapes and lines.

public class ImmediateDebugRenderObject : RenderObject

Inheritance

object

RenderObject

ImmediateDebugRenderObject

Inherited Members

RenderObject.Enabled

RenderObject.RenderGroup

RenderObject.BoundingBox

RenderObject.RenderFeature

RenderObject.ObjectNode

RenderObject.StaticObjectNode

RenderObject.VisibilityObjectNode

RenderObject.ActiveRenderStages

RenderObject.StateSortKey

RenderObject.Index

RenderObject.Source

Methods

DrawCapsule(ref Vector3, float, float, ref Quaternion, ref Color, bool)

Adds a capsule to the debug render queue.

public void DrawCapsule(ref Vector3 position, float height, float radius, ref Quaternion rotation, ref Color color, bool depthTest = true)

Parameters

position Vector3

The position of the capsule.

height float

The height of the capsule.

radius float

The radius of the capsule.

rotation Quaternion

The rotation of the capsule.

color Color

The color of the capsule.

depthTest bool

Whether to use depth testing for rendering.

DrawCircle(ref Vector3, float, ref Quaternion, ref Color, bool)

Adds a circle to the debug render queue.

public void DrawCircle(ref Vector3 position, float radius, ref Quaternion rotation, ref Color color, bool depthTest = true)

Parameters

position Vector3

The position of the circle.

radius float

The radius of the circle.

rotation Quaternion

The rotation of the circle.

color Color

The color of the circle.

depthTest bool

Whether to use depth testing for rendering.

DrawCone(ref Vector3, float, float, ref Quaternion, ref Color, bool)

Adds a cone to the debug render queue.

public void DrawCone(ref Vector3 position, float height, float radius, ref Quaternion rotation, ref Color color, bool depthTest = true)

Parameters

position Vector3

The position of the cone.

height float

The height of the cone.

radius float

The radius of the cone.

rotation Quaternion

The rotation of the cone.

color Color

The color of the cone.

depthTest bool

Whether to use depth testing for rendering.

DrawCube(ref Vector3, ref Vector3, ref Quaternion, ref Color, bool)

Adds a cube to the debug render queue.

public void DrawCube(ref Vector3 start, ref Vector3 end, ref Quaternion rotation, ref Color color, bool depthTest = true)

Parameters

start Vector3

The centre of the cube.

end Vector3

start plus the cube's size.

rotation Quaternion

The rotation of the cube.

color Color

The color of the cube.

depthTest bool

Whether to use depth testing for rendering.

DrawCylinder(ref Vector3, float, float, ref Quaternion, ref Color, bool)

Adds a cylinder to the debug render queue.

public void DrawCylinder(ref Vector3 position, float height, float radius, ref Quaternion rotation, ref Color color, bool depthTest = true)

Parameters

position Vector3

The position of the cylinder.

height float

The height of the cylinder.

radius float

The radius of the cylinder.

rotation Quaternion

The rotation of the cylinder.

color Color

The color of the cylinder.

depthTest bool

Whether to use depth testing for rendering.

DrawHalfSphere(ref Vector3, float, ref Quaternion, ref Color, bool)

Adds a half-sphere to the debug render queue.

public void DrawHalfSphere(ref Vector3 position, float radius, ref Quaternion rotation, ref Color color, bool depthTest = true)

Parameters

position Vector3

The position of the half-sphere.

radius float

The radius of the half-sphere.

rotation Quaternion

The rotation of the half-sphere.

color Color

The color of the half-sphere.

depthTest bool

Whether to use depth testing for rendering.

DrawLine(ref Vector3, ref Vector3, ref Color, bool)

Adds a line to the debug render queue.

public void DrawLine(ref Vector3 start, ref Vector3 end, ref Color color, bool depthTest = true)

Parameters

start Vector3

The starting position of the line.

end Vector3

The ending position of the line.

color Color

The color of the line.

depthTest bool

Whether to use depth testing for rendering.

DrawQuad(ref Vector3, ref Vector2, ref Quaternion, ref Color, bool)

Adds a quad to the debug render queue.

public void DrawQuad(ref Vector3 position, ref Vector2 size, ref Quaternion rotation, ref Color color, bool depthTest = true)

Parameters

position Vector3

The position of the quad.

size Vector2

The size of the quad.

rotation Quaternion

The rotation of the quad.

color Color

The color of the quad.

depthTest bool

Whether to use depth testing for rendering.

DrawSphere(ref Vector3, float, ref Color, bool)

Adds a sphere to the debug render queue.

public void DrawSphere(ref Vector3 position, float radius, ref Color color, bool depthTest = true)

Parameters

position Vector3

The position of the sphere.

radius float

The radius of the sphere.

color Color

The color of the sphere.

depthTest bool

Whether to use depth testing for rendering.