include/SDL_rect.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 18 May 2013 12:48:50 -0700
changeset 7190 11612d544fcd
parent 7185 4e201413e282
child 7191 75360622e65f
permissions -rw-r--r--
Added mobile application events, with implementations for iOS and Android
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_rect.h
    24  *  
    25  *  Header file for SDL_rect definition and management functions.
    26  */
    27 
    28 #ifndef _SDL_rect_h
    29 #define _SDL_rect_h
    30 
    31 #include "SDL_stdinc.h"
    32 #include "SDL_error.h"
    33 #include "SDL_pixels.h"
    34 #include "SDL_rwops.h"
    35 
    36 #include "begin_code.h"
    37 /* Set up for C function definitions, even when using C++ */
    38 #ifdef __cplusplus
    39 /* *INDENT-OFF* */
    40 extern "C" {
    41 /* *INDENT-ON* */
    42 #endif
    43 
    44 /**
    45  *  \brief  The structure that defines a point
    46  *
    47  *  \sa SDL_EnclosePoints
    48  */
    49 typedef struct
    50 {
    51     int x;
    52     int y;
    53 } SDL_Point;
    54 
    55 /**
    56  *  \brief A rectangle, with the origin at the upper left.
    57  *  
    58  *  \sa SDL_RectEmpty
    59  *  \sa SDL_RectEquals
    60  *  \sa SDL_HasIntersection
    61  *  \sa SDL_IntersectRect
    62  *  \sa SDL_UnionRect
    63  *  \sa SDL_EnclosePoints
    64  */
    65 typedef struct SDL_Rect
    66 {
    67     int x, y;
    68     int w, h;
    69 } SDL_Rect;
    70 
    71 /**
    72  *  \brief Returns true if the rectangle has no area.
    73  */
    74 SDL_FORCE_INLINE SDL_bool SDL_RectEmpty(const SDL_Rect *r)
    75 {
    76     return ((!r) || (r->w <= 0) || (r->h <= 0)) ? SDL_TRUE : SDL_FALSE;
    77 }
    78 
    79 /**
    80  *  \brief Returns true if the two rectangles are equal.
    81  */
    82 SDL_FORCE_INLINE SDL_bool SDL_RectEquals(const SDL_Rect *a, const SDL_Rect *b)
    83 {
    84     return (a && b && (a->x == b->x) && (a->y == b->y) &&
    85             (a->w == b->w) && (a->h == b->h)) ? SDL_TRUE : SDL_FALSE;
    86 }
    87 
    88 /**
    89  *  \brief Determine whether two rectangles intersect.
    90  *  
    91  *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
    92  */
    93 extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect * A,
    94                                                      const SDL_Rect * B);
    95 
    96 /**
    97  *  \brief Calculate the intersection of two rectangles.
    98  *  
    99  *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
   100  */
   101 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * A,
   102                                                    const SDL_Rect * B,
   103                                                    SDL_Rect * result);
   104 
   105 /**
   106  *  \brief Calculate the union of two rectangles.
   107  */
   108 extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A,
   109                                            const SDL_Rect * B,
   110                                            SDL_Rect * result);
   111 
   112 /**
   113  *  \brief Calculate a minimal rectangle enclosing a set of points
   114  *
   115  *  \return SDL_TRUE if any points were within the clipping rect
   116  */
   117 extern DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints(const SDL_Point * points,
   118                                                    int count,
   119                                                    const SDL_Rect * clip,
   120                                                    SDL_Rect * result);
   121 
   122 /**
   123  *  \brief Calculate the intersection of a rectangle and line segment.
   124  *  
   125  *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
   126  */
   127 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine(const SDL_Rect *
   128                                                           rect, int *X1,
   129                                                           int *Y1, int *X2,
   130                                                           int *Y2);
   131 
   132 /* Ends C function definitions when using C++ */
   133 #ifdef __cplusplus
   134 /* *INDENT-OFF* */
   135 }
   136 /* *INDENT-ON* */
   137 #endif
   138 #include "close_code.h"
   139 
   140 #endif /* _SDL_rect_h */
   141 
   142 /* vi: set ts=4 sw=4 expandtab: */