Skip to content

Commit 4eeae06

Browse files
committed
Add drawing.md manual
1 parent 241ffa6 commit 4eeae06

File tree

2 files changed

+45
-10
lines changed

2 files changed

+45
-10
lines changed

Documentation~/articles/drawing.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
slug: "/manual/drawing"
3+
---
4+
5+
# Drawing
6+
7+
The **Debug Tools** package includes additional functions for drawing debug information similar to Unity's `Debug.DrawLine` and `Debug.DrawRay` functions. Specifically, the package provides functions to draw wireframe boxes.
8+
9+
<hr/>
10+
11+
## 📦 Box
12+
13+
Draws a wireframe box at a given position, scale, and rotation. This can be used to visualize the bounding box of an object.
14+
15+
```csharp
16+
Draw.Box(transform.position, transform.localScale, transform.rotation, Color.green);
17+
```
18+
19+
<hr/>
20+
21+
## 📤 BoxCast
22+
23+
Draws a wireframe box using the same parameters as `Physics.BoxCast`. This can be used to visualize a boxcast from one point to another.
24+
25+
```csharp
26+
Draw.BoxCast(transform.position, transform.localScale / 2f, transform.forward, transform.rotation, 10f, Color.blue);
27+
```

Documentation~/articles/index.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,26 @@ The **Debug Tools** package contains assets and scripts for debugging Unity proj
88

99
<hr/>
1010

11-
## 📌 Overview
11+
## Overview
1212

13-
- [Scripting API](/api/Zigurous.Debug)
14-
- [Installation](/manual/installation)
15-
- [Changelog](/changelog)
16-
- [License](/license)
13+
### 🧰 [Scripting API](/api/Zigurous.Debug)
14+
15+
### ⚙️ [Installation](/manual/installation)
16+
17+
### 📋 [Changelog](/changelog)
18+
19+
### ⚖️ [License](/license)
1720

1821
<hr/>
1922

20-
## 📖 Reference
23+
## Reference
24+
25+
### 📝 [Logging](/manual/logging)
26+
27+
### ⏱️ [Benchmarking](/manual/benchmarking)
28+
29+
### [Framerate Display](/manual/framerate)
30+
31+
### 🎨 [Debug Shaders](/manual/shaders)
2132

22-
- [Logging](/manual/logging)
23-
- [Benchmarking](/manual/benchmarking)
24-
- [Framerate Display](/manual/framerate)
25-
- [Debug Shaders](/manual/shaders)
33+
### ✏️ [Drawing](/manual/benchmarking)

0 commit comments

Comments
 (0)