Added more comments.
This commit is contained in:
		@@ -11,12 +11,42 @@
 | 
			
		||||
#include "../display/primitives/quad.h"
 | 
			
		||||
#include "../display/gui/font.h"
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Initialize a GUI Frame.
 | 
			
		||||
 * 
 | 
			
		||||
 * @param frame Frame to initialize.
 | 
			
		||||
 */
 | 
			
		||||
void frameInit(frame_t *frame);
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Set the size of the frame (including the size of the border).
 | 
			
		||||
 * 
 | 
			
		||||
 * @param frame Frame to set the size of.
 | 
			
		||||
 * @param width Width of the frame.
 | 
			
		||||
 * @param height Height of the frame
 | 
			
		||||
 */
 | 
			
		||||
void frameSetSize(frame_t *frame, float width, float height);
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Set the size of the frame's innards (size excluding the borders).
 | 
			
		||||
 * 
 | 
			
		||||
 * @param frame Frame to set the size of
 | 
			
		||||
 * @param width Width of the inner frame.
 | 
			
		||||
 * @param height Height of the inner frame.
 | 
			
		||||
 */
 | 
			
		||||
void frameSetInnerSize(frame_t *frame, float width, float height);
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Render a game frame.
 | 
			
		||||
 * 
 | 
			
		||||
 * @param frame Frame to render.
 | 
			
		||||
 * @param shader Shader to use while rendering.
 | 
			
		||||
 */
 | 
			
		||||
void frameRender(frame_t *frame, shader_t *shader);
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Cleanup a previously initialized frame.
 | 
			
		||||
 * 
 | 
			
		||||
 * @param frame Frame to dispose.
 | 
			
		||||
 */
 | 
			
		||||
void frameDispose(frame_t *frame);
 | 
			
		||||
		Reference in New Issue
	
	Block a user