include/SDL_rect.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 02 Feb 2014 00:53:27 -0800
changeset 8149 681eb46b8ac4
parent 7729 384d5ba7ee44
child 8930 d000e6339d41
permissions -rw-r--r--
Fixed bug 2374 - Update copyright for 2014...

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