include/SDL_rect.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 11 Feb 2011 22:37:15 -0800
changeset 5262 b530ef003506
parent 5156 307ccc9c135e
child 5535 96594ac5fd1a
permissions -rw-r--r--
Happy 2011! :)
slouken@2275
     1
/*
slouken@2275
     2
    SDL - Simple DirectMedia Layer
slouken@5262
     3
    Copyright (C) 1997-2011 Sam Lantinga
slouken@2275
     4
slouken@2275
     5
    This library is free software; you can redistribute it and/or
slouken@2275
     6
    modify it under the terms of the GNU Lesser General Public
slouken@2275
     7
    License as published by the Free Software Foundation; either
slouken@2275
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@2275
     9
slouken@2275
    10
    This library is distributed in the hope that it will be useful,
slouken@2275
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@2275
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@2275
    13
    Lesser General Public License for more details.
slouken@2275
    14
slouken@2275
    15
    You should have received a copy of the GNU Lesser General Public
slouken@2275
    16
    License along with this library; if not, write to the Free Software
slouken@2275
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@2275
    18
slouken@2275
    19
    Sam Lantinga
slouken@2275
    20
    slouken@libsdl.org
slouken@2275
    21
*/
slouken@2275
    22
slouken@2275
    23
/**
slouken@3407
    24
 *  \file SDL_rect.h
slouken@3407
    25
 *  
slouken@3407
    26
 *  Header file for SDL_rect definition and management functions.
slouken@2275
    27
 */
slouken@2275
    28
slouken@2275
    29
#ifndef _SDL_rect_h
slouken@2275
    30
#define _SDL_rect_h
slouken@2275
    31
slouken@2275
    32
#include "SDL_stdinc.h"
slouken@2275
    33
#include "SDL_error.h"
slouken@2275
    34
#include "SDL_pixels.h"
slouken@2275
    35
#include "SDL_rwops.h"
slouken@2275
    36
slouken@2275
    37
#include "begin_code.h"
slouken@2275
    38
/* Set up for C function definitions, even when using C++ */
slouken@2275
    39
#ifdef __cplusplus
slouken@2275
    40
/* *INDENT-OFF* */
slouken@2275
    41
extern "C" {
slouken@2275
    42
/* *INDENT-ON* */
slouken@2275
    43
#endif
slouken@2275
    44
slouken@2275
    45
/**
slouken@3536
    46
 *  \brief  The structure that defines a point
slouken@3536
    47
 *
slouken@3536
    48
 *  \sa SDL_EnclosePoints
slouken@3536
    49
 */
slouken@3536
    50
typedef struct
slouken@3536
    51
{
slouken@3536
    52
    int x;
slouken@3536
    53
    int y;
slouken@3536
    54
} SDL_Point;
slouken@3536
    55
slouken@3536
    56
/**
slouken@3407
    57
 *  \brief A rectangle, with the origin at the upper left.
slouken@3407
    58
 *  
slouken@3407
    59
 *  \sa SDL_RectEmpty
slouken@3407
    60
 *  \sa SDL_RectEquals
slouken@3407
    61
 *  \sa SDL_HasIntersection
slouken@3407
    62
 *  \sa SDL_IntersectRect
slouken@3407
    63
 *  \sa SDL_UnionRect
slouken@3536
    64
 *  \sa SDL_EnclosePoints
slouken@2275
    65
 */
slouken@2275
    66
typedef struct SDL_Rect
slouken@2275
    67
{
slouken@2275
    68
    int x, y;
slouken@2275
    69
    int w, h;
slouken@2275
    70
} SDL_Rect;
slouken@2275
    71
slouken@2275
    72
/**
slouken@3407
    73
 *  \brief Returns true if the rectangle has no area.
slouken@2275
    74
 */
slouken@2275
    75
#define SDL_RectEmpty(X)    (((X)->w <= 0) || ((X)->h <= 0))
slouken@2275
    76
slouken@2275
    77
/**
slouken@3407
    78
 *  \brief Returns true if the two rectangles are equal.
slouken@2275
    79
 */
slouken@2275
    80
#define SDL_RectEquals(A, B)   (((A)->x == (B)->x) && ((A)->y == (B)->y) && \
slouken@2275
    81
                                ((A)->w == (B)->w) && ((A)->h == (B)->h))
slouken@2275
    82
slouken@2275
    83
/**
slouken@3407
    84
 *  \brief Determine whether two rectangles intersect.
slouken@3407
    85
 *  
slouken@3407
    86
 *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
slouken@2275
    87
 */
slouken@2275
    88
extern DECLSPEC SDL_bool SDLCALL SDL_HasIntersection(const SDL_Rect * A,
slouken@2275
    89
                                                     const SDL_Rect * B);
slouken@2275
    90
slouken@2275
    91
/**
slouken@3407
    92
 *  \brief Calculate the intersection of two rectangles.
slouken@3407
    93
 *  
slouken@3407
    94
 *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
slouken@2275
    95
 */
slouken@2275
    96
extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRect(const SDL_Rect * A,
slouken@2275
    97
                                                   const SDL_Rect * B,
slouken@2275
    98
                                                   SDL_Rect * result);
slouken@2275
    99
slouken@2275
   100
/**
slouken@3407
   101
 *  \brief Calculate the union of two rectangles.
slouken@2275
   102
 */
slouken@2275
   103
extern DECLSPEC void SDLCALL SDL_UnionRect(const SDL_Rect * A,
slouken@2275
   104
                                           const SDL_Rect * B,
slouken@2275
   105
                                           SDL_Rect * result);
slouken@2275
   106
slouken@2909
   107
/**
slouken@3536
   108
 *  \brief Calculate a minimal rectangle enclosing a set of points
slouken@3536
   109
 *
slouken@3536
   110
 *  \return SDL_TRUE if any points were within the clipping rect
slouken@3536
   111
 */
slouken@3536
   112
extern DECLSPEC SDL_bool SDLCALL SDL_EnclosePoints(const SDL_Point * points,
slouken@3536
   113
                                                   int count,
slouken@3536
   114
                                                   const SDL_Rect * clip,
slouken@3536
   115
                                                   SDL_Rect * result);
slouken@3536
   116
slouken@3536
   117
/**
slouken@3407
   118
 *  \brief Calculate the intersection of a rectangle and line segment.
slouken@3407
   119
 *  
slouken@3407
   120
 *  \return SDL_TRUE if there is an intersection, SDL_FALSE otherwise.
slouken@2909
   121
 */
slouken@2909
   122
extern DECLSPEC SDL_bool SDLCALL SDL_IntersectRectAndLine(const SDL_Rect *
slouken@2909
   123
                                                          rect, int *X1,
slouken@2909
   124
                                                          int *Y1, int *X2,
slouken@2909
   125
                                                          int *Y2);
slouken@2909
   126
slouken@2275
   127
/* Ends C function definitions when using C++ */
slouken@2275
   128
#ifdef __cplusplus
slouken@2275
   129
/* *INDENT-OFF* */
slouken@2275
   130
}
slouken@2275
   131
/* *INDENT-ON* */
slouken@2275
   132
#endif
slouken@2275
   133
#include "close_code.h"
slouken@2275
   134
slouken@2275
   135
#endif /* _SDL_rect_h */
slouken@2275
   136
slouken@2275
   137
/* vi: set ts=4 sw=4 expandtab: */