Minor - Start the Doxygen doc - V12.8.0

This commit is contained in:
2025-07-28 15:26:10 +02:00
parent 2c005592f0
commit 9431552316
445 changed files with 100476 additions and 72 deletions

View File

@@ -10,10 +10,31 @@ namespace ecs {
class RenderSystem {
public:
/**
* Builder for the RenderSystem class.
* This class is responsible for rendering entities with the necessary components.
* @param deviceContext
* @param shaderManager
*/
RenderSystem(ID3D11DeviceContext* deviceContext, shader_manager_class* shaderManager)
: m_deviceContext(deviceContext), m_shaderManager(shaderManager) {}
// Rendu d'une entit<69> sp<73>cifique
/**
* Render an entity with the necessary components.
* This method checks if the entity has the required components and renders it using the appropriate shader.
* @param entity The entity to render.
* @param viewMatrix The view matrix for rendering.
* @param projectionMatrix The projection matrix for rendering.
* @param diffuseColors Array of diffuse colors for lighting.
* @param lightPositions Array of light positions for lighting.
* @param ambientColors Array of ambient colors for lighting.
* @param cameraPosition The position of the camera in world space.
* @param sunlightDiffuse The diffuse color of sunlight.
* @param sunlightAmbient The ambient color of sunlight.
* @param sunlightDirection The direction of sunlight in world space.
* @param sunlightIntensity The intensity of sunlight.
* @return True if rendering was successful, false otherwise.
*/
bool RenderEntity(std::shared_ptr<Entity> entity,
const DirectX::XMMATRIX& viewMatrix,
const DirectX::XMMATRIX& projectionMatrix,
@@ -174,7 +195,22 @@ public:
}
}
// Rendu de toutes les entit<69>s avec les composants n<>cessaires
/**
* Render all entities in the EntityManager that have the necessary components.
* This method iterates through all entities and renders them if they have the required components.
* @param entityManager The EntityManager containing the entities to render.
* @param viewMatrix The view matrix for rendering.
* @param projectionMatrix The projection matrix for rendering.
* @param diffuseColors Array of diffuse colors for lighting.
* @param lightPositions Array of light positions for lighting.
* @param ambientColors Array of ambient colors for lighting.
* @param cameraPos The position of the camera in world space.
* @param sunlightDiffuse The diffuse color of sunlight.
* @param sunlightAmbient The ambient color of sunlight.
* @param sunlightDirection The direction of sunlight in world space.
* @param sunlightIntensity The intensity of sunlight.
* @return The number of entities rendered successfully.
*/
int RenderAllEntities(EntityManager* entityManager,
const DirectX::XMMATRIX& viewMatrix,
const DirectX::XMMATRIX& projectionMatrix,