mirror of
https://github.com/DCFApixels/DragonECS-ClassicThreads.git
synced 2025-09-17 19:24:37 +08:00
77 lines
4.2 KiB
Markdown
77 lines
4.2 KiB
Markdown
<p align="center">
|
||
<img width="400" src="https://github.com/DCFApixels/DragonECS-ClassicThreads/assets/99481254/fe788eb4-dcb5-40a9-b25f-4094753bc021.png">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img alt="Version" src="https://img.shields.io/github/package-json/v/DCFApixels/DragonECS-ClassicThreads?color=%23ff4e85&style=for-the-badge">
|
||
<img alt="License" src="https://img.shields.io/github/license/DCFApixels/DragonECS-ClassicThreads?color=ff4e85&style=for-the-badge">
|
||
<!--<img alt="Discord" src="https://img.shields.io/discord/1111696966208999525?color=%23ff4e85&label=Discord&logo=Discord&logoColor=%23ff4e85&style=for-the-badge">-->
|
||
</p>
|
||
|
||
# Классические C# Threads для [DragonECS](https://github.com/DCFApixels/DragonECS)
|
||
|
||
| Languages: | [Русский](https://github.com/DCFApixels/DragonECS-ClassicThreads/blob/main/README-RU.md) | [English(WIP)](https://github.com/DCFApixels/DragonECS-ClassicThreads) |
|
||
| :--- | :--- | :--- |
|
||
|
||
Поддержка обработки сущностей в нескольких потоках, на основе классической реализации потоков в C#.
|
||
> [!WARNING]
|
||
> Проект в стадии разработки. API может меняться.
|
||
|
||
# Оглавление
|
||
* [Установка](#Установка)
|
||
* [Зависимости](#Зависимости)
|
||
* [Unity-модуль](#Unity-модуль)
|
||
* [В виде исходников](#В-виде-иходников)
|
||
* [Параллельная итерация группы](#Параллельная-итерация-группы)
|
||
|
||
</br>
|
||
|
||
# Установка
|
||
Семантика версионирования - [Открыть](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md)
|
||
## Окружение
|
||
Обязательные требования:
|
||
+ Зависимость: [DragonECS](https://github.com/DCFApixels/DragonECS)
|
||
+ Минимальная версия C# 7.3;
|
||
|
||
Опционально:
|
||
+ Поддержка NativeAOT
|
||
+ Игровые движки с C#: Unity, Godot, MonoGame и т.д.
|
||
|
||
Протестированно:
|
||
+ **Unity:** Минимальная версия 2020.1.0;
|
||
|
||
## Установка для Unity
|
||
* ### Unity-модуль
|
||
Поддерживается установка в виде Unity-модуля в при помощи добавления git-URL [в PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) или ручного добавления в `Packages/manifest.json`:
|
||
```
|
||
https://github.com/DCFApixels/DragonECS-AutoInjections.git
|
||
```
|
||
* ### В виде иходников
|
||
Фреймворк так же может быть добавлен в проект в виде исходников.
|
||
|
||
</br>
|
||
|
||
# Параллельная итерация
|
||
``` csharp
|
||
EcsThreadHandler _handler;
|
||
public void Run(EcsPipeline pipeline)
|
||
{
|
||
//Получение Аспекта и сцщностей для итерации.
|
||
var group = _world.Where(out Aspect a);
|
||
void Handler(ReadOnlySpan<int> entities)
|
||
{
|
||
foreach (var e in entities)
|
||
{
|
||
//Вычисления в отедльном потоке.
|
||
a.poses.Get(e).position += a.velocities.Read(e).value * _time.DeltaTime;
|
||
}
|
||
}
|
||
// Запускает параллельную итерацию по сущностям,
|
||
// сущности будут разбита на части с минимальным размером 1000.
|
||
group.IterateParallel(_handler ??= Handler, 1000);
|
||
}
|
||
```
|
||
> **NOTICE:** Чем меньше минимальный размер части группы при делении, тем больше потоков может быть задействовано, в некоторых ситуациях слишком много потоков может негативно повлиять на производительность.
|
||
|
||
> **NOTICE:** Внутри обработчика запрещено создавать/удалять сущности, запрещено добавлять/удалять компоненты на сущности. Допускается только модификация данных внутри компонентов.
|