add code
This commit is contained in:
Rune
521
src/SDL_rect.bf
Normal file
521
src/SDL_rect.bf
Normal file
@@ -0,0 +1,521 @@
|
||||
// This file was generated by Cpp2Beef
|
||||
|
||||
using System;
|
||||
using System.Interop;
|
||||
using static SDL3.SDL;
|
||||
|
||||
namespace SDL3;
|
||||
|
||||
extension SDL
|
||||
{
|
||||
/*
|
||||
Simple DirectMedia Layer
|
||||
Copyright (C) 1997-2026 Sam Lantinga <slouken@libsdl.org>
|
||||
|
||||
This software is provided 'as-is', without any express or implied
|
||||
warranty. In no event will the authors be held liable for any damages
|
||||
arising from the use of this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose,
|
||||
including commercial applications, and to alter it and redistribute it
|
||||
freely, subject to the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software
|
||||
in a product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
*/
|
||||
|
||||
/**
|
||||
* # CategoryRect
|
||||
*
|
||||
* Some helper functions for managing rectangles and 2D points, in both
|
||||
* integer and floating point versions.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/* Set up for C function definitions, even when using C++ */
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* The structure that defines a point (using integers).
|
||||
*
|
||||
* \since This struct is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetRectEnclosingPoints
|
||||
* \sa SDL_PointInRect
|
||||
*/
|
||||
[CRepr] public struct Point
|
||||
{
|
||||
public c_int x;
|
||||
public c_int y;
|
||||
}
|
||||
|
||||
/**
|
||||
* The structure that defines a point (using floating point values).
|
||||
*
|
||||
* \since This struct is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetRectEnclosingPointsFloat
|
||||
* \sa SDL_PointInRectFloat
|
||||
*/
|
||||
[CRepr] public struct FPoint
|
||||
{
|
||||
public float x;
|
||||
public float y;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* A rectangle, with the origin at the upper left (using integers).
|
||||
*
|
||||
* \since This struct is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_RectEmpty
|
||||
* \sa SDL_RectsEqual
|
||||
* \sa SDL_HasRectIntersection
|
||||
* \sa SDL_GetRectIntersection
|
||||
* \sa SDL_GetRectAndLineIntersection
|
||||
* \sa SDL_GetRectUnion
|
||||
* \sa SDL_GetRectEnclosingPoints
|
||||
*/
|
||||
[CRepr] public struct Rect
|
||||
{
|
||||
public c_int x; public c_int y;
|
||||
public c_int w; public c_int h;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* A rectangle stored using floating point values.
|
||||
*
|
||||
* The origin of the coordinate space is in the top-left, with increasing
|
||||
* values moving down and right. The properties `x` and `y` represent the
|
||||
* coordinates of the top-left corner of the rectangle.
|
||||
*
|
||||
* \since This struct is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_RectEmptyFloat
|
||||
* \sa SDL_RectsEqualFloat
|
||||
* \sa SDL_RectsEqualEpsilon
|
||||
* \sa SDL_HasRectIntersectionFloat
|
||||
* \sa SDL_GetRectIntersectionFloat
|
||||
* \sa SDL_GetRectAndLineIntersectionFloat
|
||||
* \sa SDL_GetRectUnionFloat
|
||||
* \sa SDL_GetRectEnclosingPointsFloat
|
||||
* \sa SDL_PointInRectFloat
|
||||
*/
|
||||
[CRepr] public struct FRect
|
||||
{
|
||||
public float x;
|
||||
public float y;
|
||||
public float w;
|
||||
public float h;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Convert an SDL_Rect to SDL_FRect
|
||||
*
|
||||
* \param rect a pointer to an SDL_Rect.
|
||||
* \param frect a pointer filled in with the floating point representation of
|
||||
* `rect`.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_RectToFRect")] public static extern void RectToFRect(Rect* rect, out FRect frect);
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Determine whether a point resides inside a rectangle.
|
||||
*
|
||||
* A point is considered part of a rectangle if both `p` and `r` are not NULL,
|
||||
* and `p`'s x and y coordinates are >= to the rectangle's top left corner,
|
||||
* and < the rectangle's x+w and y+h. So a 1x1 rectangle considers point (0,0)
|
||||
* as "inside" and (0,1) as not.
|
||||
*
|
||||
* Note that this is a forced-inline function in a header, and not a public
|
||||
* API function available in the SDL library (which is to say, the code is
|
||||
* embedded in the calling program and the linker and dynamic loader will not
|
||||
* be able to find this function inside SDL itself).
|
||||
*
|
||||
* \param p the point to test.
|
||||
* \param r the rectangle to test.
|
||||
* \returns true if `p` is contained by `r`, false otherwise.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_PointInRect")] public static extern bool PointInRect(Point* p, Rect* r);
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Determine whether a rectangle has no area.
|
||||
*
|
||||
* A rectangle is considered "empty" for this function if `r` is NULL, or if
|
||||
* `r`'s width and/or height are <= 0.
|
||||
*
|
||||
* Note that this is a forced-inline function in a header, and not a public
|
||||
* API function available in the SDL library (which is to say, the code is
|
||||
* embedded in the calling program and the linker and dynamic loader will not
|
||||
* be able to find this function inside SDL itself).
|
||||
*
|
||||
* \param r the rectangle to test.
|
||||
* \returns true if the rectangle is "empty", false otherwise.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_RectEmpty")] public static extern bool RectEmpty(Rect* r);
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Determine whether two rectangles are equal.
|
||||
*
|
||||
* Rectangles are considered equal if both are not NULL and each of their x,
|
||||
* y, width and height match.
|
||||
*
|
||||
* Note that this is a forced-inline function in a header, and not a public
|
||||
* API function available in the SDL library (which is to say, the code is
|
||||
* embedded in the calling program and the linker and dynamic loader will not
|
||||
* be able to find this function inside SDL itself).
|
||||
*
|
||||
* \param a the first rectangle to test.
|
||||
* \param b the second rectangle to test.
|
||||
* \returns true if the rectangles are equal, false otherwise.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_RectsEqual")] public static extern bool RectsEqual(Rect* a, Rect* b);
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Determine whether two rectangles intersect.
|
||||
*
|
||||
* If either pointer is NULL the function will return false.
|
||||
*
|
||||
* \param A an SDL_Rect structure representing the first rectangle.
|
||||
* \param B an SDL_Rect structure representing the second rectangle.
|
||||
* \returns true if there is an intersection, false otherwise.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetRectIntersection
|
||||
*/
|
||||
[LinkName("SDL_HasRectIntersection")] public static extern bool HasRectIntersection(Rect* A, Rect* B);
|
||||
|
||||
/**
|
||||
* Calculate the intersection of two rectangles.
|
||||
*
|
||||
* If `result` is NULL then this function will return false.
|
||||
*
|
||||
* \param A an SDL_Rect structure representing the first rectangle.
|
||||
* \param B an SDL_Rect structure representing the second rectangle.
|
||||
* \param result an SDL_Rect structure filled in with the intersection of
|
||||
* rectangles `A` and `B`.
|
||||
* \returns true if there is an intersection, false otherwise.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_HasRectIntersection
|
||||
*/
|
||||
[LinkName("SDL_GetRectIntersection")] public static extern bool GetRectIntersection(Rect* A, Rect* B, Rect* result);
|
||||
|
||||
/**
|
||||
* Calculate the union of two rectangles.
|
||||
*
|
||||
* \param A an SDL_Rect structure representing the first rectangle.
|
||||
* \param B an SDL_Rect structure representing the second rectangle.
|
||||
* \param result an SDL_Rect structure filled in with the union of rectangles
|
||||
* `A` and `B`.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_GetRectUnion")] public static extern bool GetRectUnion(Rect* A, Rect* B, Rect* result);
|
||||
|
||||
/**
|
||||
* Calculate a minimal rectangle enclosing a set of points.
|
||||
*
|
||||
* If `clip` is not NULL then only points inside of the clipping rectangle are
|
||||
* considered.
|
||||
*
|
||||
* \param points an array of SDL_Point structures representing points to be
|
||||
* enclosed.
|
||||
* \param count the number of structures in the `points` array.
|
||||
* \param clip an SDL_Rect used for clipping or NULL to enclose all points.
|
||||
* \param result an SDL_Rect structure filled in with the minimal enclosing
|
||||
* rectangle.
|
||||
* \returns true if any points were enclosed or false if all the points were
|
||||
* outside of the clipping rectangle.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_GetRectEnclosingPoints")] public static extern bool GetRectEnclosingPoints(Point* points, c_int count, Rect* clip, Rect* result);
|
||||
|
||||
/**
|
||||
* Calculate the intersection of a rectangle and line segment.
|
||||
*
|
||||
* This function is used to clip a line segment to a rectangle. A line segment
|
||||
* contained entirely within the rectangle or that does not intersect will
|
||||
* remain unchanged. A line segment that crosses the rectangle at either or
|
||||
* both ends will be clipped to the boundary of the rectangle and the new
|
||||
* coordinates saved in `X1`, `Y1`, `X2`, and/or `Y2` as necessary.
|
||||
*
|
||||
* \param rect an SDL_Rect structure representing the rectangle to intersect.
|
||||
* \param X1 a pointer to the starting X-coordinate of the line.
|
||||
* \param Y1 a pointer to the starting Y-coordinate of the line.
|
||||
* \param X2 a pointer to the ending X-coordinate of the line.
|
||||
* \param Y2 a pointer to the ending Y-coordinate of the line.
|
||||
* \returns true if there is an intersection, false otherwise.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_GetRectAndLineIntersection")] public static extern bool GetRectAndLineIntersection(Rect* rect, c_int* X1, c_int* Y1, c_int* X2, c_int* Y2);
|
||||
|
||||
|
||||
/* SDL_FRect versions... */
|
||||
|
||||
/**
|
||||
* Determine whether a point resides inside a floating point rectangle.
|
||||
*
|
||||
* A point is considered part of a rectangle if both `p` and `r` are not NULL,
|
||||
* and `p`'s x and y coordinates are >= to the rectangle's top left corner,
|
||||
* and <= the rectangle's x+w and y+h. So a 1x1 rectangle considers point
|
||||
* (0,0) and (0,1) as "inside" and (0,2) as not.
|
||||
*
|
||||
* Note that this is a forced-inline function in a header, and not a public
|
||||
* API function available in the SDL library (which is to say, the code is
|
||||
* embedded in the calling program and the linker and dynamic loader will not
|
||||
* be able to find this function inside SDL itself).
|
||||
*
|
||||
* \param p the point to test.
|
||||
* \param r the rectangle to test.
|
||||
* \returns true if `p` is contained by `r`, false otherwise.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_PointInRectFloat")] public static extern bool PointInRectFloat(FPoint* p, FRect* r);
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Determine whether a floating point rectangle takes no space.
|
||||
*
|
||||
* A rectangle is considered "empty" for this function if `r` is NULL, or if
|
||||
* `r`'s width and/or height are < 0.0f.
|
||||
*
|
||||
* Note that this is a forced-inline function in a header, and not a public
|
||||
* API function available in the SDL library (which is to say, the code is
|
||||
* embedded in the calling program and the linker and dynamic loader will not
|
||||
* be able to find this function inside SDL itself).
|
||||
*
|
||||
* \param r the rectangle to test.
|
||||
* \returns true if the rectangle is "empty", false otherwise.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_RectEmptyFloat")] public static extern bool RectEmptyFloat(FRect* r);
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Determine whether two floating point rectangles are equal, within some
|
||||
* given epsilon.
|
||||
*
|
||||
* Rectangles are considered equal if both are not NULL and each of their x,
|
||||
* y, width and height are within `epsilon` of each other. If you don't know
|
||||
* what value to use for `epsilon`, you should call the SDL_RectsEqualFloat
|
||||
* function instead.
|
||||
*
|
||||
* Note that this is a forced-inline function in a header, and not a public
|
||||
* API function available in the SDL library (which is to say, the code is
|
||||
* embedded in the calling program and the linker and dynamic loader will not
|
||||
* be able to find this function inside SDL itself).
|
||||
*
|
||||
* \param a the first rectangle to test.
|
||||
* \param b the second rectangle to test.
|
||||
* \param epsilon the epsilon value for comparison.
|
||||
* \returns true if the rectangles are equal, false otherwise.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_RectsEqualFloat
|
||||
*/
|
||||
[LinkName("SDL_RectsEqualEpsilon")] public static extern bool RectsEqualEpsilon(FRect* a, FRect* b, float epsilon);
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Determine whether two floating point rectangles are equal, within a default
|
||||
* epsilon.
|
||||
*
|
||||
* Rectangles are considered equal if both are not NULL and each of their x,
|
||||
* y, width and height are within SDL_FLT_EPSILON of each other. This is often
|
||||
* a reasonable way to compare two floating point rectangles and deal with the
|
||||
* slight precision variations in floating point calculations that tend to pop
|
||||
* up.
|
||||
*
|
||||
* Note that this is a forced-inline function in a header, and not a public
|
||||
* API function available in the SDL library (which is to say, the code is
|
||||
* embedded in the calling program and the linker and dynamic loader will not
|
||||
* be able to find this function inside SDL itself).
|
||||
*
|
||||
* \param a the first rectangle to test.
|
||||
* \param b the second rectangle to test.
|
||||
* \returns true if the rectangles are equal, false otherwise.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_RectsEqualEpsilon
|
||||
*/
|
||||
[LinkName("SDL_RectsEqualFloat")] public static extern bool RectsEqualFloat(FRect* a, FRect* b);
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Determine whether two rectangles intersect with float precision.
|
||||
*
|
||||
* If either pointer is NULL the function will return false.
|
||||
*
|
||||
* \param A an SDL_FRect structure representing the first rectangle.
|
||||
* \param B an SDL_FRect structure representing the second rectangle.
|
||||
* \returns true if there is an intersection, false otherwise.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetRectIntersectionFloat
|
||||
*/
|
||||
[LinkName("SDL_HasRectIntersectionFloat")] public static extern bool HasRectIntersectionFloat(FRect* A, FRect* B);
|
||||
|
||||
/**
|
||||
* Calculate the intersection of two rectangles with float precision.
|
||||
*
|
||||
* If `result` is NULL then this function will return false.
|
||||
*
|
||||
* \param A an SDL_FRect structure representing the first rectangle.
|
||||
* \param B an SDL_FRect structure representing the second rectangle.
|
||||
* \param result an SDL_FRect structure filled in with the intersection of
|
||||
* rectangles `A` and `B`.
|
||||
* \returns true if there is an intersection, false otherwise.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_HasRectIntersectionFloat
|
||||
*/
|
||||
[LinkName("SDL_GetRectIntersectionFloat")] public static extern bool GetRectIntersectionFloat(FRect* A, FRect* B, FRect* result);
|
||||
|
||||
/**
|
||||
* Calculate the union of two rectangles with float precision.
|
||||
*
|
||||
* \param A an SDL_FRect structure representing the first rectangle.
|
||||
* \param B an SDL_FRect structure representing the second rectangle.
|
||||
* \param result an SDL_FRect structure filled in with the union of rectangles
|
||||
* `A` and `B`.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_GetRectUnionFloat")] public static extern bool GetRectUnionFloat(FRect* A, FRect* B, FRect* result);
|
||||
|
||||
/**
|
||||
* Calculate a minimal rectangle enclosing a set of points with float
|
||||
* precision.
|
||||
*
|
||||
* If `clip` is not NULL then only points inside of the clipping rectangle are
|
||||
* considered.
|
||||
*
|
||||
* \param points an array of SDL_FPoint structures representing points to be
|
||||
* enclosed.
|
||||
* \param count the number of structures in the `points` array.
|
||||
* \param clip an SDL_FRect used for clipping or NULL to enclose all points.
|
||||
* \param result an SDL_FRect structure filled in with the minimal enclosing
|
||||
* rectangle.
|
||||
* \returns true if any points were enclosed or false if all the points were
|
||||
* outside of the clipping rectangle.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_GetRectEnclosingPointsFloat")] public static extern bool GetRectEnclosingPointsFloat(FPoint* points, c_int count, FRect* clip, FRect* result);
|
||||
|
||||
/**
|
||||
* Calculate the intersection of a rectangle and line segment with float
|
||||
* precision.
|
||||
*
|
||||
* This function is used to clip a line segment to a rectangle. A line segment
|
||||
* contained entirely within the rectangle or that does not intersect will
|
||||
* remain unchanged. A line segment that crosses the rectangle at either or
|
||||
* both ends will be clipped to the boundary of the rectangle and the new
|
||||
* coordinates saved in `X1`, `Y1`, `X2`, and/or `Y2` as necessary.
|
||||
*
|
||||
* \param rect an SDL_FRect structure representing the rectangle to intersect.
|
||||
* \param X1 a pointer to the starting X-coordinate of the line.
|
||||
* \param Y1 a pointer to the starting Y-coordinate of the line.
|
||||
* \param X2 a pointer to the ending X-coordinate of the line.
|
||||
* \param Y2 a pointer to the ending Y-coordinate of the line.
|
||||
* \returns true if there is an intersection, false otherwise.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_GetRectAndLineIntersectionFloat")] public static extern bool GetRectAndLineIntersectionFloat(FRect* rect, float* X1, float* Y1, float* X2, float* Y2);
|
||||
}
|
||||
|
||||
/* Ends C function definitions when using C++ */
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/* SDL_rect_h_ */
|
||||
Reference in New Issue
Block a user