docs: added documentation to draw & update interfaces
This commit is contained in:
parent
877a004a13
commit
832514ba7d
@ -1,6 +1,12 @@
|
||||
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
|
||||
{
|
||||
/// <summary>
|
||||
/// Calls draw logic for the <see cref="IBehaviour"/> to be displayed visually.
|
||||
/// </summary>
|
||||
void Draw();
|
||||
}
|
||||
|
@ -1,6 +1,12 @@
|
||||
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
|
||||
{
|
||||
/// <summary>
|
||||
/// Updates the state of the <see cref="IBehaviour"/> after the main draw phase happens.
|
||||
/// </summary>
|
||||
void PostDraw();
|
||||
}
|
||||
|
@ -1,6 +1,12 @@
|
||||
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
|
||||
{
|
||||
/// <summary>
|
||||
/// Updates the state of the <see cref="IBehaviour"/> after the main update phase happens.
|
||||
/// </summary>
|
||||
void PostUpdate();
|
||||
}
|
||||
|
@ -1,6 +1,12 @@
|
||||
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
|
||||
{
|
||||
/// <summary>
|
||||
/// Updates the state of the <see cref="IBehaviour"/> before the main draw phase happens.
|
||||
/// </summary>
|
||||
void PreDraw();
|
||||
}
|
||||
|
@ -1,6 +1,12 @@
|
||||
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
|
||||
{
|
||||
/// <summary>
|
||||
/// Updates the state of the <see cref="IBehaviour"/> before the main update phase happens.
|
||||
/// </summary>
|
||||
void PreUpdate();
|
||||
}
|
||||
|
@ -1,6 +1,12 @@
|
||||
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
|
||||
{
|
||||
/// <summary>
|
||||
/// Updates the state of the <see cref="IBehaviour"/>.
|
||||
/// </summary>
|
||||
void Update();
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user