updated rect class and added some documentation

This commit is contained in:
herbglitch 2023-06-23 23:07:39 -06:00
parent 2b02bf9d2e
commit 3565a5cf15
3 changed files with 74 additions and 0 deletions

View file

@ -21,8 +21,61 @@ typedef struct ARC_URect {
uint32_t h;
} ARC_URect;
typedef struct ARC_FRect {
float x;
float y;
float w;
float h;
} ARC_FRect;
/**
* @brief centers rect on given bounds
*
* @param rect ARC_Rect to be centered
* @param bounds ARC_Rect area to center rect on
*/
void ARC_Rect_CenterOn(ARC_Rect *rect, ARC_Rect *bounds);
/**
* @brief centers rect on given bounds
*
* @param rect ARC_FRect to be centered
* @param bounds ARC_FRect area to center rect on
*/
void ARC_FRect_CenterOn(ARC_FRect *rect, ARC_FRect *bounds);
/**
* @brief casts FRect to Rect
*
* @param rect ARC_FRect to be casted
*
* @return ARC_Rect
*/
ARC_Rect ARC_FRect_CastToRect(ARC_FRect *rect);
/**
* @brief checks if two ARC_Rects intersect
*
* @param rect1 ARC_Rect that will be checked against rect2
* @param rect2 ARC_Rect that will be checked against rect1
*
* @return 1 if they intersect, 0 if they don't intersect
*/
int32_t ARC_Rect_Intersects(ARC_Rect *rect1, ARC_Rect *rect2);
/**
* @brief checks if ARC_Rect intersects a line
*
* @note need to update this documenation to word it better
*
* @param rect ARC_Rect that will be checked against line
* @param x1 first point's x value
* @param y1 first point's y value
* @param y2 second point's x value
* @param y2 second point's y value
*
* @return 1 if they intersect, 0 if they don't intersect
*/
int32_t ARC_Rect_LineIntersects(ARC_Rect *rect, int32_t *x1, int32_t *y1, int32_t *x2, int32_t *y2);
#ifdef __cplusplus