mirror of
https://github.com/DCFApixels/DragonECS-ClassicThreads.git
synced 2025-09-17 10:54:35 +08:00
update readme
This commit is contained in:
Mikhail
parent
cda6d13f1e
commit
b74366156d
41
README-RU.md
41
README-RU.md
@ -14,7 +14,9 @@
|
||||
| :--- | :--- | :--- |
|
||||
|
||||
Поддержка обработки сущностей в нескольких потоках, на основе классической реализации потоков в C#.
|
||||
> **NOTICE:** Проект в стадии разработки. API может меняться.
|
||||
> [!WARNING]
|
||||
> Проект в стадии разработки. API может меняться.
|
||||
|
||||
# Оглавление
|
||||
* [Установка](#Установка)
|
||||
* [Зависимости](#Зависимости)
|
||||
@ -22,37 +24,50 @@
|
||||
* [В виде исходников](#В-виде-иходников)
|
||||
* [Параллельная итерация группы](#Параллельная-итерация-группы)
|
||||
|
||||
</br>
|
||||
|
||||
# Установка
|
||||
### Зависимости
|
||||
Убедитесь что в проекте установлен фреймворк [DragonECS](https://github.com/DCFApixels/DragonECS).
|
||||
Семантика версионирования - [Открыть](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
|
||||
```
|
||||
* ### В виде исходников
|
||||
Фреймворк так же может быть добавлен в проект в виде исходников.
|
||||
* ### В виде иходников
|
||||
Фреймворк так же может быть добавлен в проект в виде исходников.
|
||||
|
||||
### Версионирование
|
||||
В DragonECS применяется следующая семантика версионирования: [Открыть](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D0%BE%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5)
|
||||
</br>
|
||||
|
||||
# Параллельная итерация группы
|
||||
# Параллельная итерация
|
||||
``` csharp
|
||||
EcsThreadHandler _handler;
|
||||
public void Run(EcsPipeline pipeline)
|
||||
{
|
||||
//Получение субъекта и группы для итерации.
|
||||
var group = _world.Where(out Subject s);
|
||||
//Получение Аспекта и сцщностей для итерации.
|
||||
var group = _world.Where(out Aspect a);
|
||||
void Handler(ReadOnlySpan<int> entities)
|
||||
{
|
||||
foreach (var e in entities)
|
||||
{
|
||||
//Вычисления в отедльном потоке.
|
||||
s.poses.Get(e).position += s.velocities.Read(e).value * _time.DeltaTime;
|
||||
a.poses.Get(e).position += a.velocities.Read(e).value * _time.DeltaTime;
|
||||
}
|
||||
}
|
||||
// Запускает параллельную итерацию по группе,
|
||||
// группа будет рабита на части с минимальным размером 1000.
|
||||
// Запускает параллельную итерацию по сущностям,
|
||||
// сущности будут разбита на части с минимальным размером 1000.
|
||||
group.IterateParallel(_handler ??= Handler, 1000);
|
||||
}
|
||||
```
|
||||
|
||||
50
README.md
50
README.md
@ -17,5 +17,51 @@ Support for processing entities in multiple threads, based on classic C# threads
|
||||
> **NOTICE:** The project is a work in progress, API may change.
|
||||
> While the English version of the README is incomplete, you can view the [Russian version](https://github.com/DCFApixels/DragonECS-ClassicThreads/blob/main/README-RU.md).
|
||||
|
||||
# Versioning
|
||||
DragonECS uses this versioning semantics: [Open](https://gist.github.com/DCFApixels/c3b178a308b411f530361d1d56f1f929#versioning)
|
||||
</br>
|
||||
|
||||
# Installation
|
||||
Versioning semantics - [Open](https://gist.github.com/DCFApixels/e53281d4628b19fe5278f3e77a7da9e8#file-dcfapixels_versioning_ru-md)
|
||||
## Environment
|
||||
Requirements:
|
||||
+ Dependency: [DragonECS](https://github.com/DCFApixels/DragonECS)
|
||||
+ Minimum version of C# 7.3;
|
||||
|
||||
Optional:
|
||||
+ Support for NativeAOT
|
||||
+ Game engines with C#: Unity, Godot, MonoGame, etc.
|
||||
|
||||
Tested with:
|
||||
+ **Unity:** Minimum version 2020.1.0;
|
||||
|
||||
</br>
|
||||
|
||||
## Unity Installation
|
||||
* ### Unity Package
|
||||
The framework can be installed as a Unity package by adding the Git URL [in the PackageManager](https://docs.unity3d.com/2023.2/Documentation/Manual/upm-ui-giturl.html) or manually adding it to `Packages/manifest.json`:
|
||||
```
|
||||
https://github.com/DCFApixels/DragonECS-ClassicThreads.git
|
||||
```
|
||||
* ### Source Code
|
||||
The framework can also be added to the project as source code.
|
||||
|
||||
</br>
|
||||
|
||||
# Parallel iteration
|
||||
``` 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;
|
||||
}
|
||||
}
|
||||
group.IterateParallel(_handler ??= Handler, 1000);
|
||||
}
|
||||
```
|
||||
> **NOTICE:** The smaller the minimum size of the group part when dividing, the more threads can be utilized. In some situations, too many threads can negatively impact performance.
|
||||
|
||||
> **NOTICE:** Inside the handler, creating/deleting entities, adding/removing components on entities is prohibited. Only modification of data within components is allowed.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user