include/SDL_rect.h
author David Ludwig <dludwig@pobox.com>
Mon, 01 Apr 2013 21:33:06 -0400
changeset 8453 499aa167ea79
parent 6885 700f1b25f77f
child 7185 4e201413e282
permissions -rw-r--r--
WinRT: made WinRT path retrieval be available in both UCS-2 and UTF-8 flavors
     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 #define SDL_RectEmpty(X)    ((!(X)) || ((X)->w <= 0) || ((X)->h <= 0))
    75 
    76 /**
    77  *  \brief Returns true if the two rectangles are equal.
    78  */
    79 #define SDL_RectEquals(A, B)   (((A)) && ((B)) && \
    80                                 ((A)->x == (B)->x) && ((A)->y == (B)->y) && \
    81                                 ((A)->w == (B)->w) && ((A)->h == (B)->h))
    82 
    83 /**
    84  *  \brief Determine whether two rectangles intersect.
    85  *  
    86  *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
    87  */
    88 extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect * A,
    89                                                      const SDL_Rect * B);
    90 
    91 /**
    92  *  \brief Calculate the intersection of two rectangles.
    93  *  
    94  *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
    95  */
    96 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * A,
    97                                                    const SDL_Rect * B,
    98                                                    SDL_Rect * result);
    99 
   100 /**
   101  *  \brief Calculate the union of two rectangles.
   102  */
   103 extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A,
   104                                            const SDL_Rect * B,
   105                                            SDL_Rect * result);
   106 
   107 /**
   108  *  \brief Calculate a minimal rectangle enclosing a set of points
   109  *
   110  *  \return SDL_TRUE if any points were within the clipping rect
   111  */
   112 extern DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints(const SDL_Point * points,
   113                                                    int count,
   114                                                    const SDL_Rect * clip,
   115                                                    SDL_Rect * result);
   116 
   117 /**
   118  *  \brief Calculate the intersection of a rectangle and line segment.
   119  *  
   120  *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
   121  */
   122 extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine(const SDL_Rect *
   123                                                           rect, int *X1,
   124                                                           int *Y1, int *X2,
   125                                                           int *Y2);
   126 
   127 /* Ends C function definitions when using C++ */
   128 #ifdef __cplusplus
   129 /* *INDENT-OFF* */
   130 }
   131 /* *INDENT-ON* */
   132 #endif
   133 #include "close_code.h"
   134 
   135 #endif /* _SDL_rect_h */
   136 
   137 /* vi: set ts=4 sw=4 expandtab: */