SDL  2.0
SDL_rect.h File Reference
#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_pixels.h"
#include "SDL_rwops.h"
#include "begin_code.h"
#include "close_code.h"
+ Include dependency graph for SDL_rect.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SDL_Point
 
struct  SDL_FPoint
 
struct  SDL_Rect
 
struct  SDL_FRect
 

Functions

SDL_FORCE_INLINE SDL_bool SDL_PointInRect (const SDL_Point *p, const SDL_Rect *r)
 
SDL_FORCE_INLINE SDL_bool SDL_RectEmpty (const SDL_Rect *r)
 
SDL_FORCE_INLINE SDL_bool SDL_RectEquals (const SDL_Rect *a, const SDL_Rect *b)
 
SDL_bool SDL_HasIntersection (const SDL_Rect *A, const SDL_Rect *B)
 
SDL_bool SDL_IntersectRect (const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result)
 
void SDL_UnionRect (const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result)
 
SDL_bool SDL_EnclosePoints (const SDL_Point *points, int count, const SDL_Rect *clip, SDL_Rect *result)
 
SDL_bool SDL_IntersectRectAndLine (const SDL_Rect *rect, int *X1, int *Y1, int *X2, int *Y2)
 

Detailed Description

Header file for SDL_rect definition and management functions.

Definition in file SDL_rect.h.

Function Documentation

◆ SDL_EnclosePoints()

SDL_bool SDL_EnclosePoints ( const SDL_Point points,
int  count,
const SDL_Rect clip,
SDL_Rect result 
)

Calculate a minimal rectangle enclosing a set of points.

If clip is not NULL then only points inside of the clipping rectangle are considered.

Parameters
pointsan array of SDL_Point structures representing points to be enclosed
countthe number of structures in the points array
clipan SDL_Rect used for clipping or NULL to enclose all points
resultan SDL_Rect structure filled in with the minimal enclosing rectangle
Returns
SDL_TRUE if any points were enclosed or SDL_FALSE if all the points were outside of the clipping rectangle.
Since
This function is available since SDL 2.0.0.

◆ SDL_HasIntersection()

SDL_bool SDL_HasIntersection ( const SDL_Rect A,
const SDL_Rect B 
)

Determine whether two rectangles intersect.

If either pointer is NULL the function will return SDL_FALSE.

Parameters
Aan SDL_Rect structure representing the first rectangle
Ban SDL_Rect structure representing the second rectangle
Returns
SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
Since
This function is available since SDL 2.0.0.
See also
SDL_IntersectRect

◆ SDL_IntersectRect()

SDL_bool SDL_IntersectRect ( const SDL_Rect A,
const SDL_Rect B,
SDL_Rect result 
)

Calculate the intersection of two rectangles.

If result is NULL then this function will return SDL_FALSE.

Parameters
Aan SDL_Rect structure representing the first rectangle
Ban SDL_Rect structure representing the second rectangle
resultan SDL_Rect structure filled in with the intersection of rectangles A and B
Returns
SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
Since
This function is available since SDL 2.0.0.
See also
SDL_HasIntersection

◆ SDL_IntersectRectAndLine()

SDL_bool SDL_IntersectRectAndLine ( const SDL_Rect rect,
int *  X1,
int *  Y1,
int *  X2,
int *  Y2 
)

Calculate the intersection of a rectangle and line segment.

This function is used to clip a line segment to a rectangle. A line segment contained entirely within the rectangle or that does not intersect will remain unchanged. A line segment that crosses the rectangle at either or both ends will be clipped to the boundary of the rectangle and the new coordinates saved in X1, Y1, X2, and/or Y2 as necessary.

Parameters
rectan SDL_Rect structure representing the rectangle to intersect
X1a pointer to the starting X-coordinate of the line
Y1a pointer to the starting Y-coordinate of the line
X2a pointer to the ending X-coordinate of the line
Y2a pointer to the ending Y-coordinate of the line
Returns
SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
Since
This function is available since SDL 2.0.0.

◆ SDL_PointInRect()

SDL_FORCE_INLINE SDL_bool SDL_PointInRect ( const SDL_Point p,
const SDL_Rect r 
)

Returns true if point resides inside a rectangle.

Definition at line 99 of file SDL_rect.h.

100 {
101  return ( (p->x >= r->x) && (p->x < (r->x + r->w)) &&
102  (p->y >= r->y) && (p->y < (r->y + r->h)) ) ? SDL_TRUE : SDL_FALSE;
103 }
@ SDL_TRUE
Definition: SDL_stdinc.h:181
@ SDL_FALSE
Definition: SDL_stdinc.h:180
int x
Definition: SDL_rect.h:50
int y
Definition: SDL_rect.h:51
int h
Definition: SDL_rect.h:80
int w
Definition: SDL_rect.h:80
int y
Definition: SDL_rect.h:79
int x
Definition: SDL_rect.h:79

References SDL_Rect::h, SDL_FALSE, SDL_TRUE, SDL_Rect::w, SDL_Point::x, SDL_Rect::x, SDL_Point::y, and SDL_Rect::y.

◆ SDL_RectEmpty()

SDL_FORCE_INLINE SDL_bool SDL_RectEmpty ( const SDL_Rect r)

Returns true if the rectangle has no area.

Definition at line 108 of file SDL_rect.h.

109 {
110  return ((!r) || (r->w <= 0) || (r->h <= 0)) ? SDL_TRUE : SDL_FALSE;
111 }

References SDL_Rect::h, SDL_FALSE, SDL_TRUE, and SDL_Rect::w.

◆ SDL_RectEquals()

SDL_FORCE_INLINE SDL_bool SDL_RectEquals ( const SDL_Rect a,
const SDL_Rect b 
)

Returns true if the two rectangles are equal.

Definition at line 116 of file SDL_rect.h.

117 {
118  return (a && b && (a->x == b->x) && (a->y == b->y) &&
119  (a->w == b->w) && (a->h == b->h)) ? SDL_TRUE : SDL_FALSE;
120 }

References SDL_Rect::h, SDL_FALSE, SDL_TRUE, SDL_Rect::w, SDL_Rect::x, and SDL_Rect::y.

◆ SDL_UnionRect()

void SDL_UnionRect ( const SDL_Rect A,
const SDL_Rect B,
SDL_Rect result 
)

Calculate the union of two rectangles.

Parameters
Aan SDL_Rect structure representing the first rectangle
Ban SDL_Rect structure representing the second rectangle
resultan SDL_Rect structure filled in with the union of rectangles A and B
Since
This function is available since SDL 2.0.0.