242 lines
8.2 KiB
Beef
242 lines
8.2 KiB
Beef
// 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.
|
|
*/
|
|
|
|
|
|
|
|
|
|
/**
|
|
* # CategoryTime
|
|
*
|
|
* SDL realtime clock and date/time routines.
|
|
*
|
|
* There are two data types that are used in this category: SDL_Time, which
|
|
* represents the nanoseconds since a specific moment (an "epoch"), and
|
|
* SDL_DateTime, which breaks time down into human-understandable components:
|
|
* years, months, days, hours, etc.
|
|
*
|
|
* Much of the functionality is involved in converting those two types to
|
|
* other useful forms.
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
/* Set up for C function definitions, even when using C++ */
|
|
|
|
|
|
|
|
|
|
/**
|
|
* A structure holding a calendar date and time broken down into its
|
|
* components.
|
|
*
|
|
* \since This struct is available since SDL 3.2.0.
|
|
*/
|
|
[CRepr] public struct DateTime
|
|
{
|
|
public c_int year; /**< Year */
|
|
public c_int month; /**< Month [01-12] */
|
|
public c_int day; /**< Day of the month [01-31] */
|
|
public c_int hour; /**< Hour [0-23] */
|
|
public c_int minute; /**< Minute [0-59] */
|
|
public c_int second; /**< Seconds [0-60] */
|
|
public c_int nanosecond; /**< Nanoseconds [0-999999999] */
|
|
public c_int day_of_week; /**< Day of the week [0-6] (0 being Sunday) */
|
|
public c_int utc_offset; /**< Seconds east of UTC */
|
|
}
|
|
|
|
/**
|
|
* The preferred date format of the current system locale.
|
|
*
|
|
* \since This enum is available since SDL 3.2.0.
|
|
*
|
|
* \sa SDL_GetDateTimeLocalePreferences
|
|
*/
|
|
[AllowDuplicates] public enum DateFormat : c_int
|
|
{
|
|
Yyyymmdd = 0, /**< Year/Month/Day */
|
|
Ddmmyyyy = 1, /**< Day/Month/Year */
|
|
Mmddyyyy = 2, /**< Month/Day/Year */
|
|
}
|
|
|
|
/**
|
|
* The preferred time format of the current system locale.
|
|
*
|
|
* \since This enum is available since SDL 3.2.0.
|
|
*
|
|
* \sa SDL_GetDateTimeLocalePreferences
|
|
*/
|
|
[AllowDuplicates] public enum TimeFormat : c_int
|
|
{
|
|
_24hr = 0, /**< 24 hour time */
|
|
_12hr = 1, /**< 12 hour time */
|
|
}
|
|
|
|
/**
|
|
* Gets the current preferred date and time format for the system locale.
|
|
*
|
|
* This might be a "slow" call that has to query the operating system. It's
|
|
* best to ask for this once and save the results. However, the preferred
|
|
* formats can change, usually because the user has changed a system
|
|
* preference outside of your program.
|
|
*
|
|
* \param dateFormat a pointer to the SDL_DateFormat to hold the returned date
|
|
* format, may be NULL.
|
|
* \param timeFormat a pointer to the SDL_TimeFormat to hold the returned time
|
|
* format, may be NULL.
|
|
* \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_GetDateTimeLocalePreferences")] public static extern bool GetDateTimeLocalePreferences(DateFormat* dateFormat, TimeFormat* timeFormat);
|
|
|
|
/**
|
|
* Gets the current value of the system realtime clock in nanoseconds since
|
|
* Jan 1, 1970 in Universal Coordinated Time (UTC).
|
|
*
|
|
* \param ticks the SDL_Time to hold the returned tick count.
|
|
* \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_GetCurrentTime")] public static extern bool GetCurrentTime(Time* ticks);
|
|
|
|
/**
|
|
* Converts an SDL_Time in nanoseconds since the epoch to a calendar time in
|
|
* the SDL_DateTime format.
|
|
*
|
|
* \param ticks the SDL_Time to be converted.
|
|
* \param dt the resulting SDL_DateTime.
|
|
* \param localTime the resulting SDL_DateTime will be expressed in local time
|
|
* if true, otherwise it will be in Universal Coordinated
|
|
* Time (UTC).
|
|
* \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_TimeToDateTime")] public static extern bool TimeToDateTime(Time ticks, DateTime* dt, bool localTime);
|
|
|
|
/**
|
|
* Converts a calendar time to an SDL_Time in nanoseconds since the epoch.
|
|
*
|
|
* This function ignores the day_of_week member of the SDL_DateTime struct, so
|
|
* it may remain unset.
|
|
*
|
|
* \param dt the source SDL_DateTime.
|
|
* \param ticks the resulting SDL_Time.
|
|
* \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_DateTimeToTime")] public static extern bool DateTimeToTime(DateTime* dt, Time* ticks);
|
|
|
|
/**
|
|
* Converts an SDL time into a Windows FILETIME (100-nanosecond intervals
|
|
* since January 1, 1601).
|
|
*
|
|
* This function fills in the two 32-bit values of the FILETIME structure.
|
|
*
|
|
* \param ticks the time to convert.
|
|
* \param dwLowDateTime a pointer filled in with the low portion of the
|
|
* Windows FILETIME value.
|
|
* \param dwHighDateTime a pointer filled in with the high portion of the
|
|
* Windows FILETIME value.
|
|
*
|
|
* \since This function is available since SDL 3.2.0.
|
|
*/
|
|
[LinkName("SDL_TimeToWindows")] public static extern void TimeToWindows(Time ticks, out Uint32 dwLowDateTime, out Uint32 dwHighDateTime);
|
|
|
|
/**
|
|
* Converts a Windows FILETIME (100-nanosecond intervals since January 1,
|
|
* 1601) to an SDL time.
|
|
*
|
|
* This function takes the two 32-bit values of the FILETIME structure as
|
|
* parameters.
|
|
*
|
|
* \param dwLowDateTime the low portion of the Windows FILETIME value.
|
|
* \param dwHighDateTime the high portion of the Windows FILETIME value.
|
|
* \returns the converted SDL time.
|
|
*
|
|
* \since This function is available since SDL 3.2.0.
|
|
*/
|
|
[LinkName("SDL_TimeFromWindows")] public static extern Time TimeFromWindows(Uint32 dwLowDateTime, Uint32 dwHighDateTime);
|
|
|
|
/**
|
|
* Get the number of days in a month for a given year.
|
|
*
|
|
* \param year the year.
|
|
* \param month the month [1-12].
|
|
* \returns the number of days in the requested month or -1 on failure; call
|
|
* SDL_GetError() for more information.
|
|
*
|
|
* \since This function is available since SDL 3.2.0.
|
|
*/
|
|
[LinkName("SDL_GetDaysInMonth")] public static extern c_int GetDaysInMonth(c_int year, c_int month);
|
|
|
|
/**
|
|
* Get the day of year for a calendar date.
|
|
*
|
|
* \param year the year component of the date.
|
|
* \param month the month component of the date.
|
|
* \param day the day component of the date.
|
|
* \returns the day of year [0-365] if the date is valid or -1 on failure;
|
|
* call SDL_GetError() for more information.
|
|
*
|
|
* \since This function is available since SDL 3.2.0.
|
|
*/
|
|
[LinkName("SDL_GetDayOfYear")] public static extern c_int GetDayOfYear(c_int year, c_int month, c_int day);
|
|
|
|
/**
|
|
* Get the day of week for a calendar date.
|
|
*
|
|
* \param year the year component of the date.
|
|
* \param month the month component of the date.
|
|
* \param day the day component of the date.
|
|
* \returns a value between 0 and 6 (0 being Sunday) if the date is valid or
|
|
* -1 on failure; call SDL_GetError() for more information.
|
|
*
|
|
* \since This function is available since SDL 3.2.0.
|
|
*/
|
|
[LinkName("SDL_GetDayOfWeek")] public static extern c_int GetDayOfWeek(c_int year, c_int month, c_int day);
|
|
}
|
|
|
|
/* Ends C function definitions when using C++ */
|
|
|
|
|
|
|
|
|
|
|
|
/* SDL_time_h_ */
|
|
|