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:
Mikhail 2025-02-23 21:00:25 +08:00 committed by GitHub
parent ac593b8a22
commit d57024492c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -2,23 +2,29 @@
![image](https://github.com/user-attachments/assets/fb3edbce-9164-4ad7-a7a2-85748edf58e0)
Многофункциональный, расширяемый и высоко производительный инструмент для рисования Gizmos для Unity.
Многофункциональная, расширяемая и высокопроизводительная утилита рисования Gizmos для Unity. Работает как в редакторе так и в билде, а вызывать методы отрисовки можно в Update.
API для рисования заготовленные Gizmo:
Синтаксис рисования заготовленныех Gizmo:
```c#
DebugX.Draw(duration, color).*Gizmo Function*(...);
```
![image](https://github.com/user-attachments/assets/97d77716-145d-4357-bcb1-8601871d2fe0)
API для рисования кастомного меша и материала:
```c#
//Рисования любого меша lit материалом. Без GPU instancing.
DebugX.Draw(...).Mesh(mesh, pos, rot, sc);
//UnlitMesh - меш с unlit материалом
//WireMesh - меш с wireframe материалом
```
```c#
//Рисования статического меша lit материалом. В режиме GPU instancing.
DebugX.Draw(...).Mesh<IStaticMesh>(pos, rot, sc);
//UnlitMesh<IStaticMesh> - меш с unlit материалом
//WireMesh<IStaticMesh> - меш с wireframe материалом
```
```c#
//Рисования статического меша статическим материалом. В режиме GPU instancing.
DebugX.Draw(...).Mesh<IStaticMesh, IStaticMat>(pos, rot, sc);
```
@ -28,17 +34,25 @@ DebugX.Draw(...).Mesh<IStaticMesh, IStaticMat>(pos, rot, sc);
// Статический меш.
public struct SomeMesh : IStaticMesh
{
public Mesh GetMesh() => StaticStorage.SomeMesh;
public Mesh GetMesh() => StaticStorage.SomeMesh;
}
```
```c#
// Статический материал.
public struct SomeMesh : IStaticMesh
{
public int GetExecutuonOrder() => 100;
public Mesh GetMaterial() => StaticStorage.SomeMaterial;
// Контроль порядка выполнения рендереров.
public int GetExecutuonOrder() => 100;
public Mesh GetMaterial() => StaticStorage.SomeMaterial;
}
```
Утилита для загрузки мешей: //TODO
Окно настроек "Tools -> DebugX -> Settings":
![image](https://github.com/user-attachments/assets/7dd981c1-1e00-4b7d-9a73-376638094689)
Утилита для загрузки статических ассетов: //TODO
Кастомная реализация Gizmo:
```c#
@ -55,9 +69,11 @@ public readonly struct SomeGizmo : IGizmo<SomeGizmo>
private class Renderer : IGizmoRenderer<SomeGizmo>
{
// Контроль порядка выполнения рендереров.
public int ExecuteOrder => //...
// Флаг системе о способе оптимизации. Если метод рисовки или подготовки зависят от текущей камеры, то false，иначе true. Если не уверены то выбирайте false.
public bool IsStaticRender => //...
public int ExecuteOrder => 0; //можно использовать default(SomeMat).GetExecutuonOrder();
// Флаг системе о способе оптимизации.
// Если метод рисовки или подготовки зависят от текущей камеры, то false，иначе true.
// Если не уверены то выбирайте false.
public bool IsStaticRender => false;
// Подготовка данных перед рендером, тут можно выполнить дополнительные расчеты или запланировать Job.
public void Prepare(Camera camera, GizmosList<SomeGizmo> list)
@ -85,7 +101,7 @@ public static class SomeGizmoExtensions
{
public static DrawHandler SomeGizmo(this DrawHandler self, /*...*/)
{
self.Gizmo(new SomeGizmo( /*...*/);
self.Gizmo(new SomeGizmo(/*...*/);
return self;
}
}