My Project
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Classes | Typedefs | Functions
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"

Go to the source code of this file.

Classes

struct  SDL_Point
 The structure that defines a point. More...
 
struct  SDL_Rect
 A rectangle, with the origin at the upper left. More...
 

Typedefs

typedef struct SDL_Point SDL_Point
 The structure that defines a point. More...
 
typedef struct SDL_Rect SDL_Rect
 A rectangle, with the origin at the upper left. More...
 

Functions

SDL_FORCE_INLINE SDL_bool SDL_RectEmpty (const SDL_Rect *r)
 Returns true if the rectangle has no area.
 
SDL_FORCE_INLINE SDL_bool SDL_RectEquals (const SDL_Rect *a, const SDL_Rect *b)
 Returns true if the two rectangles are equal.
 
DECLSPEC SDL_bool SDLCALL SDL_HasIntersection (const SDL_Rect *A, const SDL_Rect *B)
 Determine whether two rectangles intersect. More...
 
DECLSPEC SDL_bool SDLCALL SDL_IntersectRect (const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result)
 Calculate the intersection of two rectangles. More...
 
DECLSPEC void SDLCALL SDL_UnionRect (const SDL_Rect *A, const SDL_Rect *B, SDL_Rect *result)
 Calculate the union of two rectangles.
 
DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints (const SDL_Point *points, int count, const SDL_Rect *clip, SDL_Rect *result)
 Calculate a minimal rectangle enclosing a set of points. More...
 
DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine (const SDL_Rect *rect, int *X1, int *Y1, int *X2, int *Y2)
 Calculate the intersection of a rectangle and line segment. More...
 

Detailed Description

Header file for SDL_rect definition and management functions.

Typedef Documentation

typedef struct SDL_Point SDL_Point

The structure that defines a point.

See Also
SDL_EnclosePoints
typedef struct SDL_Rect SDL_Rect

A rectangle, with the origin at the upper left.

See Also
SDL_RectEmpty
SDL_RectEquals
SDL_HasIntersection
SDL_IntersectRect
SDL_UnionRect
SDL_EnclosePoints

Function Documentation

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

Calculate a minimal rectangle enclosing a set of points.

Returns
SDL_TRUE if any points were within the clipping rect
DECLSPEC SDL_bool SDLCALL SDL_HasIntersection ( const SDL_Rect A,
const SDL_Rect B 
)

Determine whether two rectangles intersect.

Returns
SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
DECLSPEC SDL_bool SDLCALL SDL_IntersectRect ( const SDL_Rect A,
const SDL_Rect B,
SDL_Rect result 
)

Calculate the intersection of two rectangles.

Returns
SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine ( const SDL_Rect rect,
int X1,
int Y1,
int X2,
int Y2 
)

Calculate the intersection of a rectangle and line segment.

Returns
SDL_TRUE if there is an intersection, SDL_FALSE otherwise.