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
slouken@2275
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 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@3407
    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
/* *INDENT-OFF* */
slouken@2275
    40
extern "C" {
slouken@2275
    41
/* *INDENT-ON* */
slouken@2275
    42
#endif
slouken@2275
    43
slouken@2275
    44
/**
slouken@3536
    45
 *  \brief  The structure that defines a point
slouken@3536
    46
 *
slouken@3536
    47
 *  \sa SDL_EnclosePoints
slouken@3536
    48
 */
slouken@3536
    49
typedef struct
slouken@3536
    50
{
slouken@3536
    51
    int x;
slouken@3536
    52
    int y;
slouken@3536
    53
} SDL_Point;
slouken@3536
    54
slouken@3536
    55
/**
slouken@3407
    56
 *  \brief A rectangle, with the origin at the upper left.
slouken@3407
    57
 *  
slouken@3407
    58
 *  \sa SDL_RectEmpty
slouken@3407
    59
 *  \sa SDL_RectEquals
slouken@3407
    60
 *  \sa SDL_HasIntersection
slouken@3407
    61
 *  \sa SDL_IntersectRect
slouken@3407
    62
 *  \sa SDL_UnionRect
slouken@3536
    63
 *  \sa SDL_EnclosePoints
slouken@2275
    64
 */
slouken@2275
    65
typedef struct SDL_Rect
slouken@2275
    66
{
slouken@2275
    67
    int x, y;
slouken@2275
    68
    int w, h;
slouken@2275
    69
} SDL_Rect;
slouken@2275
    70
slouken@2275
    71
/**
slouken@3407
    72
 *  \brief Returns true if the rectangle has no area.
slouken@2275
    73
 */
aschiffler@5947
    74
#define SDL_RectEmpty(X)    ((!(X)) || ((X)->w <= 0) || ((X)->h <= 0))
slouken@2275
    75
slouken@2275
    76
/**
slouken@3407
    77
 *  \brief Returns true if the two rectangles are equal.
slouken@2275
    78
 */
aschiffler@5949
    79
#define SDL_RectEquals(A, B)   (((A)) && ((B)) && \
aschiffler@5947
    80
                                ((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: */