Hymn to Beauty
C++ 3D Engine
Video::DebugDrawing Class Reference

Draws debug primitives. More...

#include <DebugDrawing.hpp>

Classes

struct  Circle
 A debug drawing circle. More...
 
struct  Cone
 A debug drawing cone. More...
 
struct  Cuboid
 A debug drawing cuboid. More...
 
struct  Cylinder
 A debug drawing cylinder. More...
 
struct  Line
 A debug drawing line. More...
 
struct  Mesh
 A debug drawing mesh. More...
 
struct  Plane
 A debug drawing plane. More...
 
struct  Point
 A debug drawing point. More...
 
struct  Sphere
 A debug drawing sphere. More...
 

Public Member Functions

 DebugDrawing (Renderer *renderer)
 Create new debug primitive renderer. More...
 
 ~DebugDrawing ()
 Destructor. More...
 
void StartDebugDrawing (CommandBuffer *commandBuffer, const glm::mat4 &viewProjectionMatrix)
 Start rendering debug primitives. More...
 
void DrawPoint (const Point &point)
 Draw a point. More...
 
void DrawLine (const Line &line)
 Draw a line. More...
 
void DrawCuboid (const Cuboid &cuboid)
 Draw a cuboid. More...
 
void DrawPlane (const Plane &plane)
 Draw a plane. More...
 
void DrawCircle (const Circle &circle)
 Draw a circle. More...
 
void DrawSphere (const Sphere &sphere)
 Draw a sphere. More...
 
void DrawCylinder (const Cylinder &cylinder)
 Draw a cylinder. More...
 
void DrawCone (const Cone &cone)
 Draw a cone. More...
 
void DrawMesh (const Mesh &mesh)
 Draw a mesh. More...
 
void EndDebugDrawing ()
 Stop debug drawing. More...
 

Detailed Description

Draws debug primitives.

Constructor & Destructor Documentation

◆ DebugDrawing()

DebugDrawing::DebugDrawing ( Renderer renderer)
explicit

Create new debug primitive renderer.

Parameters
rendererThe renderer to use.

◆ ~DebugDrawing()

DebugDrawing::~DebugDrawing ( )

Destructor.

Member Function Documentation

◆ DrawCircle()

void DebugDrawing::DrawCircle ( const Circle circle)

Draw a circle.

Parameters
circleThe circle to draw.

◆ DrawCone()

void DebugDrawing::DrawCone ( const Cone cone)

Draw a cone.

Parameters
coneThe cone to draw.

◆ DrawCuboid()

void DebugDrawing::DrawCuboid ( const Cuboid cuboid)

Draw a cuboid.

Parameters
cuboidThe cuboid to draw.

◆ DrawCylinder()

void DebugDrawing::DrawCylinder ( const Cylinder cylinder)

Draw a cylinder.

Parameters
cylinderThe cylinder to draw.

◆ DrawLine()

void DebugDrawing::DrawLine ( const Line line)

Draw a line.

Parameters
lineThe line to draw.

◆ DrawMesh()

void DebugDrawing::DrawMesh ( const Mesh mesh)

Draw a mesh.

Parameters
meshThe mesh to draw.

◆ DrawPlane()

void DebugDrawing::DrawPlane ( const Plane plane)

Draw a plane.

Parameters
planeThe plane to draw.

◆ DrawPoint()

void DebugDrawing::DrawPoint ( const Point point)

Draw a point.

Parameters
pointThe point to draw.

◆ DrawSphere()

void DebugDrawing::DrawSphere ( const Sphere sphere)

Draw a sphere.

Parameters
sphereThe sphere to draw.

◆ EndDebugDrawing()

void DebugDrawing::EndDebugDrawing ( )

Stop debug drawing.

◆ StartDebugDrawing()

void DebugDrawing::StartDebugDrawing ( CommandBuffer commandBuffer,
const glm::mat4 &  viewProjectionMatrix 
)

Start rendering debug primitives.

Needs to be called before DrawPoint, DrawLine or DrawCuboid.

Parameters
commandBufferCommand buffer to use for drawing.
viewProjectionMatrixThe camera's view projection matrix.

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