doc/: definir como funcionan los archivos

This commit is contained in:
PedroEdiaz
2024-09-19 10:15:25 +06:00
parent 86ad43c2dc
commit 3c9690a2a7
3 changed files with 171 additions and 121 deletions

View File

@@ -0,0 +1,50 @@
# Estructura de archivos
Díaz Camacho Pedro Emilio
# Headers
## main.h
Este archivo incluye los prototipos internos que va a usar el programa
funge como api interna para los desarrolladores y debe estar bien documentada.
# Datos
## data/cube.h
## data/axis.h
## data/shaders.h
# codigo fuente
## main.c
Este archivo inclye la función principal, debe inicializar, ejecutar, y terminar el programa correctamente,
así como avisar de los errores cuando aparezcan.
## color.c
Incluye las funciones para escoger y pintar el color de fondo.
### Depende de
- <GL/gl.h>
## input.c
Incluye el código necesario para interactuar con el program
### Depende de
- <GLFW/glfw3.h>
- <cglm/quat.h>
## matrix.c
Debe cargar en la gpu las matrices que use el programa.
### Depende de
- <cglm/mat4.h>
- <cglm/cam.h>
- <cglm/quat.h>
## mesh.c
Debe crear, destruir y dibujar los mesh, que son la representación de objetos tridimensionales.
### Depende de
- <GL/gl.h>
- <stdlib.h>
## shader.c
Debe crear, destruir y usar los shaders, que son programas para la gpu, así como tener funciones
para cargar estructuras a la gpu.
### Depende de
- <GL/gl.h>
## texture.c
Debe cargar, usar, destruir las texturas, también crea una textura para una paleta de colores.
### Depende de
- <GL/gl.h>
## window.c
Crea, usa, y cierra una ventana, también avisa cuando la ventana está abierta.
### Depende de
- <GLFW/glfw3.h>