AlicizaX/Unity-DebugX
1
0
Fork 0
mirror of https://github.com/DCFApixels/Unity-DebugX.git synced 2025-09-18 01:54:37 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
DCFApixels 2025-02-23 21:54:58 +08:00
parent d57024492c
commit 640afff338
1 changed files with 32 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,17 +1,37 @@
# Unity-DebugX # Unity-DebugX
![image](https://github.com/user-attachments/assets/fb3edbce-9164-4ad7-a7a2-85748edf58e0) v![image](https://github.com/user-attachments/assets/fb3edbce-9164-4ad7-a7a2-85748edf58e0)
Многофункциональная, расширяемая и высокопроизводительная утилита рисования Gizmos для Unity. Работает как в редакторе так и в билде, а вызывать методы отрисовки можно в Update. Многофункциональная, расширяемая и производительная утилита рисования Gizmos для Unity. Работает как в редакторе так и в билде, а рисовать можно и в Update.
Синтаксис рисования заготовленныех Gizmo: Синтаксис:
```c# ```c#
DebugX.Draw(duration, color).*Gizmo Function*(...); DebugX.Draw(duration, color).*Gizmo Function*(...);
``` ```
![image](https://github.com/user-attachments/assets/97d77716-145d-4357-bcb1-8601871d2fe0) ![image](https://github.com/user-attachments/assets/97d77716-145d-4357-bcb1-8601871d2fe0)
API для рисования кастомного меша и материала:
# Установка
Семантика версионирования - [Открыть](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md)
### Unity-пакет
Поддерживается установка в виде Unity-пакета через добавление [в PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или ручного добавления в `Packages/manifest.json` этого git-URL:
```
https://github.com/DCFApixels/DragonECS.git
```
### В виде исходников
Пакет так же может быть добавлен в проект в виде исходников.
</br>
# API
Синтаксис рисования заготовленных Gizmo:
```c#
DebugX.Draw(duration, color).*Gizmo Function*(...);
```
Рисование кастомных меша и материала:
```c# ```c#
//Рисования любого меша lit материалом. Без GPU instancing. //Рисования любого меша lit материалом. Без GPU instancing.
DebugX.Draw(...).Mesh(mesh, pos, rot, sc); DebugX.Draw(...).Mesh(mesh, pos, rot, sc);
@ -31,7 +51,7 @@ DebugX.Draw(...).Mesh<IStaticMesh, IStaticMat>(pos, rot, sc);
Для оптимизации отрисовки используются статические данные: Для оптимизации отрисовки используются статические данные:
```c# ```c#
// Статический меш. // Статический меш. Обязателен для отрисовки с GPU instancing.
public struct SomeMesh : IStaticMesh public struct SomeMesh : IStaticMesh
{ {
public Mesh GetMesh() => StaticStorage.SomeMesh; public Mesh GetMesh() => StaticStorage.SomeMesh;
@ -42,17 +62,20 @@ public struct SomeMesh : IStaticMesh
public struct SomeMesh : IStaticMesh public struct SomeMesh : IStaticMesh
{ {
// Контроль порядка выполнения рендереров. // Контроль порядка выполнения рендереров.
public int GetExecutuonOrder() => 100; public int GetExecuteOrder() => 100;
public Mesh GetMaterial() => StaticStorage.SomeMaterial; public Mesh GetMaterial() => StaticStorage.SomeMaterial;
} }
``` ```
> Утилита для загрузки статических ассетов: //TODO
# Настройки
Окно настроек "Tools -> DebugX -> Settings": Окно настроек "Tools -> DebugX -> Settings":
![image](https://github.com/user-attachments/assets/7dd981c1-1e00-4b7d-9a73-376638094689) ![image](https://github.com/user-attachments/assets/7dd981c1-1e00-4b7d-9a73-376638094689)
# Кастомный Gizmo
Утилита для загрузки статических ассетов: //TODO
Кастомная реализация Gizmo: Кастомная реализация Gizmo:
```c# ```c#
@ -62,7 +85,7 @@ public readonly struct SomeGizmo : IGizmo<SomeGizmo>
public SomeGizmo(/*...*/) public SomeGizmo(/*...*/)
{ {
//... // Заполнение данных.
} }
public IGizmoRenderer<SomeGizmo> RegisterNewRenderer() => new Renderer(); public IGizmoRenderer<SomeGizmo> RegisterNewRenderer() => new Renderer();