Syntriax/Syntriax.Engine
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: added documentation to draw & update interfaces

Browse Source
This commit is contained in:
Syntriax 2025-05-24 13:38:39 +03:00
parent 877a004a13
commit 832514ba7d
6 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Engine.Core/Systems/Abstract/IDraw.cs
View File

@ -1,6 +1,12 @@
namespace Syntriax.Engine.Core; namespace Syntriax.Engine.Core;
/// <summary>
/// Represents a <see cref="IBehaviour"/> to be notified when the draw phase of the <see cref="IUniverse"/> occurs.
/// </summary>
public interface IDraw : IBehaviour public interface IDraw : IBehaviour
{ {
/// <summary>
/// Calls draw logic for the <see cref="IBehaviour"/> to be displayed visually.
/// </summary>
void Draw(); void Draw();
} }

6
Engine.Core/Systems/Abstract/IPostDraw.cs
View File

@ -1,6 +1,12 @@
namespace Syntriax.Engine.Core; namespace Syntriax.Engine.Core;
/// <summary>
/// Represents a <see cref="IBehaviour"/> to be notified after the draw phase of the <see cref="IUniverse"/> occurs.
/// </summary>
public interface IPostDraw : IBehaviour public interface IPostDraw : IBehaviour
{ {
/// <summary>
/// Updates the state of the <see cref="IBehaviour"/> after the main draw phase happens.
/// </summary>
void PostDraw(); void PostDraw();
} }

6
Engine.Core/Systems/Abstract/IPostUpdate.cs
View File

@ -1,6 +1,12 @@
namespace Syntriax.Engine.Core; namespace Syntriax.Engine.Core;
/// <summary>
/// Represents a <see cref="IBehaviour"/> to be notified after the update phase of the <see cref="IUniverse"/> occurs.
/// </summary>
public interface IPostUpdate : IBehaviour public interface IPostUpdate : IBehaviour
{ {
/// <summary>
/// Updates the state of the <see cref="IBehaviour"/> after the main update phase happens.
/// </summary>
void PostUpdate(); void PostUpdate();
} }

6
Engine.Core/Systems/Abstract/IPreDraw.cs
View File

@ -1,6 +1,12 @@
namespace Syntriax.Engine.Core; namespace Syntriax.Engine.Core;
/// <summary>
/// Represents a <see cref="IBehaviour"/> to be notified before the draw phase of the <see cref="IUniverse"/> occurs.
/// </summary>
public interface IPreDraw : IBehaviour public interface IPreDraw : IBehaviour
{ {
/// <summary>
/// Updates the state of the <see cref="IBehaviour"/> before the main draw phase happens.
/// </summary>
void PreDraw(); void PreDraw();
} }

6
Engine.Core/Systems/Abstract/IPreUpdate.cs
View File

@ -1,6 +1,12 @@
namespace Syntriax.Engine.Core; namespace Syntriax.Engine.Core;
/// <summary>
/// Represents a <see cref="IBehaviour"/> to be notified before the update phase of the <see cref="IUniverse"/> occurs.
/// </summary>
public interface IPreUpdate : IBehaviour public interface IPreUpdate : IBehaviour
{ {
/// <summary>
/// Updates the state of the <see cref="IBehaviour"/> before the main update phase happens.
/// </summary>
void PreUpdate(); void PreUpdate();
} }

6
Engine.Core/Systems/Abstract/IUpdate.cs
View File

@ -1,6 +1,12 @@
namespace Syntriax.Engine.Core; namespace Syntriax.Engine.Core;
/// <summary>
/// Represents a <see cref="IBehaviour"/> to be notified when the update phase of the <see cref="IUniverse"/> occurs.
/// </summary>
public interface IUpdate : IBehaviour public interface IUpdate : IBehaviour
{ {
/// <summary>
/// Updates the state of the <see cref="IBehaviour"/>.
/// </summary>
void Update(); void Update();
} }