Merged pull request "Debug line drawing": #440

inc/refresh/debug.h

@@ -0,0 +1,45 @@
+/*
+Copyright (C) 1997-2001 Id Software, Inc.
+Copyright (C) 2024-2025 Frank Richter
+Copyright (C) 2024-2025 Andrey Nazarov
+Copyright (C) 2024-2025 Jonathan "Paril" Barkley
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#ifndef REFRESH_DEBUG_H_
+#define REFRESH_DEBUG_H_
+
+#define MAX_DEBUG_LINES     8192
+#define MAX_DEBUG_VERTICES  (MAX_DEBUG_LINES * 2)
+
+typedef struct {
+	list_t          entry;
+	vec3_t          start, end;
+	color_t         color;
+	uint32_t        time;
+	bool            depth_test;
+} r_debug_line_t;
+
+extern list_t r_debug_lines_free;
+extern list_t r_debug_lines_active;
+
+// Debug lines shared functionality
+extern bool R_DebugTimeExpired(const uint32_t time);
+extern void R_ExpireDebugLines(void);
+extern void R_AddDebugText_Lines(const vec3_t vieworg, const vec3_t origin, const vec3_t angles, const char *text, float size, uint32_t color, uint32_t time, bool depth_test);
+extern void R_InitDebugText(void);
+
+#endif // REFRESH_DEBUG_H_

inc/refresh/refresh.h

@@ -334,6 +334,11 @@ extern void    (*R_DrawFill32)(int x, int y, int w, int h, uint32_t color);
 extern void    (*R_UpdateRawPic)(int pic_w, int pic_h, const uint32_t *pic);
 extern void    (*R_DiscardRawPic)(void);
 
+// debug line entry points
+extern bool (*R_SupportsDebugLines)(void);
+extern void (*R_AddDebugText_)(const vec3_t origin, const vec3_t angles, const char *text,
+                               float size, uint32_t color, uint32_t time, bool depth_test);
+
 // video mode and refresh state management entry points
 extern void    (*R_BeginFrame)(void);
 extern void    (*R_EndFrame)(void);

inc/shared/debug.h

@@ -0,0 +1,41 @@
+/*
+Copyright (C) 1997-2001 Id Software, Inc.
+Copyright (C) 2024-2025 Frank Richter
+Copyright (C) 2024-2025 Andrey Nazarov
+Copyright (C) 2024-2025 Jonathan "Paril" Barkley
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#pragma once
+
+#if USE_REF
+void R_ClearDebugLines(void);
+void R_AddDebugLine(const vec3_t start, const vec3_t end, uint32_t color, uint32_t time, bool depth_test);
+void R_AddDebugText(const vec3_t origin, const vec3_t angles, const char *text,
+                    float size, uint32_t color, uint32_t time, bool depth_test);
+void R_AddDebugPoint(const vec3_t point, float size, uint32_t color, uint32_t time, bool depth_test);
+void R_AddDebugAxis(const vec3_t origin, const vec3_t angles, float size, uint32_t time, bool depth_test);
+void R_AddDebugBounds(const vec3_t mins, const vec3_t maxs, uint32_t color, uint32_t time, bool depth_test);
+void R_AddDebugSphere(const vec3_t origin, float radius, uint32_t color, uint32_t time, bool depth_test);
+void R_AddDebugCircle(const vec3_t origin, float radius, uint32_t color, uint32_t time, bool depth_test);
+void R_AddDebugCylinder(const vec3_t origin, float half_height, float radius, uint32_t color, uint32_t time, bool depth_test);
+void R_AddDebugArrow(const vec3_t start, const vec3_t end, float size, uint32_t line_color,
+                     uint32_t arrow_color, uint32_t time, bool depth_test);
+void R_AddDebugCurveArrow(const vec3_t start, const vec3_t ctrl, const vec3_t end, float size,
+                            uint32_t line_color, uint32_t arrow_color, uint32_t time, bool depth_test);
+#else
+#define R_ClearDebugLines()                     (void)0
+#endif

inc/shared/shared.h

@@ -171,8 +171,14 @@ typedef struct vrect_s {
     int             x, y, width, height;
 } vrect_t;
 
-#define DEG2RAD(a)      ((a) * (M_PI / 180))
-#define RAD2DEG(a)      ((a) * (180 / M_PI))
+#ifndef M_PIf
+#define M_PIf       3.14159265358979323846f
+#define M_SQRT2f    1.41421356237309504880f
+#define M_SQRT1_2f  0.70710678118654752440f
+#endif
+
+#define DEG2RAD(a)      ((a) * (M_PIf / 180))
+#define RAD2DEG(a)      ((a) * (180 / M_PIf))
 
 #define ALIGN(x, a)     (((x) + (a) - 1) & ~((a) - 1))
 
@@ -348,6 +354,11 @@ uint32_t Q_rand_uniform(uint32_t n);
 #define clamp(a,b,c)    ((a)<(b)?(a)=(b):(a)>(c)?(a)=(c):(a))
 #define cclamp(a,b,c)   ((b)>(c)?clamp(a,c,b):clamp(a,b,c))
 
+static inline int Q_clip(int a, int b, int c)
+{
+    return clamp(a, b, c);
+}
+
 #ifndef max
 #define max(a,b) ((a)>(b)?(a):(b))
 #endif

src/CMakeLists.txt

@@ -182,6 +182,8 @@ SET(HEADERS_COMMON
 )
 
 SET(SRC_REFRESH
+	refresh/debug.c
+	refresh/debug_text.c
 	refresh/images.c
 	refresh/models.c
 	refresh/model_iqm.c
@@ -255,6 +257,7 @@ SET(SRC_VKPT
 	refresh/vkpt/asvgf.c
 	refresh/vkpt/bloom.c
 	refresh/vkpt/bsp_mesh.c
+	refresh/vkpt/debug.c
 	refresh/vkpt/draw.c
 	refresh/vkpt/fog.c
 	refresh/vkpt/cameras.c
@@ -328,6 +331,8 @@ set(SRC_SHADERS
 	refresh/vkpt/shader/fsr_easu_fp32.comp
 	refresh/vkpt/shader/fsr_rcas_fp16.comp
 	refresh/vkpt/shader/fsr_rcas_fp32.comp
+	refresh/vkpt/shader/debug_line.frag
+	refresh/vkpt/shader/debug_line.vert
 )
 
 set(SRC_RT_SHADERS

src/client/refresh.c

@@ -23,8 +23,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 
 #include "client.h"
+#include "refresh/debug.h"
 #include "refresh/images.h"
 #include "refresh/models.h"
+#include "shared/debug.h"
 
 // Console variables that we need to access from this module
 cvar_t      *vid_rtx;
@@ -412,6 +414,10 @@ void CL_InitRefresh(void)
     SCR_Init();
     UI_Init();
 
+    R_ClearDebugLines();
+    Cmd_AddCommand("cleardebuglines", R_ClearDebugLines);
+    R_InitDebugText();
+
     SCR_RegisterMedia();
     Con_RegisterMedia();
 
@@ -434,6 +440,8 @@ void CL_ShutdownRefresh(void)
     SCR_Shutdown();
     UI_Shutdown();
 
+    Cmd_RemoveCommand("cleardebuglines");
+
     vid_geometry->changed = NULL;
     vid_fullscreen->changed = NULL;
     vid_modelist->changed = NULL;
@@ -486,6 +494,10 @@ void(*R_AddDecal)(decal_t *d) = NULL;
 bool(*R_InterceptKey)(unsigned key, bool down) = NULL;
 bool(*R_IsHDR)(void) = NULL;
 
+bool (*R_SupportsDebugLines)(void) = NULL;
+void (*R_AddDebugText_)(const vec3_t origin, const vec3_t angles, const char *text,
+                        float size, uint32_t color, uint32_t time, bool depth_test) = NULL;
+
 void(*IMG_Unload)(image_t *image) = NULL;
 void(*IMG_Load)(image_t *image, byte *pic) = NULL;
 void(*IMG_ReadPixels)(screenshot_t *s) = NULL;

src/client/view.c

@@ -19,6 +19,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 // cl_view.c -- player rendering positioning
 
 #include "client.h"
+#include "shared/debug.h"
 
 //=============
 //
@@ -44,6 +45,7 @@ static cvar_t   *cl_testparticles;
 static cvar_t   *cl_testentities;
 static cvar_t   *cl_testlights;
 static cvar_t   *cl_testblend;
+static cvar_t   *cl_testdebuglines;
 
 static cvar_t   *cl_stats;
 #endif
@@ -375,6 +377,30 @@ static void V_TestLights(void)
     }
 }
 
+static void V_TestDebugLines(void)
+{
+    static const uint32_t colors[] = {U32_RED, U32_GREEN, U32_BLUE, U32_YELLOW, U32_MAGENTA, U32_CYAN};
+    const float point_size = 16.f;
+    const float text_size = 0.5f;
+
+    bool depth_test = cl_testdebuglines->integer == 1 || cl_testdebuglines->integer == 3;
+    bool print_id = cl_testdebuglines->integer >= 3;
+    for (int i = 0; i < r_numentities; i++) {
+        const entity_t *ent = r_entities + i;
+        if (ent->id == 1 /* gun */)
+            continue;
+        uint32_t color = colors[ent->id % q_countof(colors)];
+        R_AddDebugPoint(ent->origin, point_size, color, 0, depth_test);
+
+        if (print_id) {
+            vec3_t text_org;
+            VectorCopy(ent->origin, text_org);
+            text_org[2] += point_size;
+            R_AddDebugText(text_org, NULL, va("%d", ent->id), text_size, color, 0, depth_test);
+        }
+    }
+}
+
 #endif
 
 //===================================================================
@@ -511,6 +537,8 @@ void V_RenderView(void)
             cl.refdef.blend[2] = 0.25f;
             cl.refdef.blend[3] = 0.5f;
         }
+        if (cl_testdebuglines->integer)
+            V_TestDebugLines();
 #endif
 
         if(cl_flashlight->integer)
@@ -620,6 +648,7 @@ void V_Init(void)
     cl_testparticles = Cvar_Get("cl_testparticles", "0", 0);
     cl_testentities = Cvar_Get("cl_testentities", "0", 0);
     cl_testlights = Cvar_Get("cl_testlights", "0", CVAR_CHEAT);
+    cl_testdebuglines = Cvar_Get("cl_testdebuglines", "0", CVAR_CHEAT);
 
     cl_stats = Cvar_Get("cl_stats", "0", 0);
 #endif