add code
This commit is contained in:
Rune
@@ -0,0 +1,581 @@
|
||||
// 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* # CategoryProperties
|
||||
*
|
||||
* A property is a variable that can be created and retrieved by name at
|
||||
* runtime.
|
||||
*
|
||||
* All properties are part of a property group (SDL_PropertiesID). A property
|
||||
* group can be created with the SDL_CreateProperties function and destroyed
|
||||
* with the SDL_DestroyProperties function.
|
||||
*
|
||||
* Properties can be added to and retrieved from a property group through the
|
||||
* following functions:
|
||||
*
|
||||
* - SDL_SetPointerProperty and SDL_GetPointerProperty operate on `void*`
|
||||
* pointer types.
|
||||
* - SDL_SetStringProperty and SDL_GetStringProperty operate on string types.
|
||||
* - SDL_SetNumberProperty and SDL_GetNumberProperty operate on signed 64-bit
|
||||
* integer types.
|
||||
* - SDL_SetFloatProperty and SDL_GetFloatProperty operate on floating point
|
||||
* types.
|
||||
* - SDL_SetBooleanProperty and SDL_GetBooleanProperty operate on boolean
|
||||
* types.
|
||||
*
|
||||
* Properties can be removed from a group by using SDL_ClearProperty.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/* Set up for C function definitions, even when using C++ */
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* An ID that represents a properties set.
|
||||
*
|
||||
* \since This datatype is available since SDL 3.2.0.
|
||||
*/
|
||||
public typealias PropertiesID = Uint32;
|
||||
|
||||
/**
|
||||
* SDL property type
|
||||
*
|
||||
* \since This enum is available since SDL 3.2.0.
|
||||
*/
|
||||
[AllowDuplicates] public enum PropertyType : c_int
|
||||
{
|
||||
Invalid,
|
||||
Pointer,
|
||||
String,
|
||||
Number,
|
||||
Float,
|
||||
Boolean,
|
||||
}
|
||||
|
||||
/**
|
||||
* A generic property for naming things.
|
||||
*
|
||||
* This property is intended to be added to any SDL_PropertiesID that needs a
|
||||
* generic name associated with the property set. It is not guaranteed that
|
||||
* any property set will include this key, but it is convenient to have a
|
||||
* standard key that any piece of code could reasonably agree to use.
|
||||
*
|
||||
* For example, the properties associated with an SDL_Texture might have a
|
||||
* name string of "player sprites", or an SDL_AudioStream might have
|
||||
* "background music", etc. This might also be useful for an SDL_IOStream to
|
||||
* list the path to its asset.
|
||||
*
|
||||
* There is no format for the value set with this key; it is expected to be
|
||||
* human-readable and informational in nature, possibly for logging or
|
||||
* debugging purposes.
|
||||
*
|
||||
* SDL does not currently set this property on any objects it creates, but
|
||||
* this may change in later versions; it is currently expected that apps and
|
||||
* external libraries will take advantage of it, when appropriate.
|
||||
*
|
||||
* \since This macro is available since SDL 3.4.0.
|
||||
*/
|
||||
public const let PROP_NAME_STRING = "SDL.name";
|
||||
|
||||
/**
|
||||
* Get the global SDL properties.
|
||||
*
|
||||
* \returns a valid property ID on success or 0 on failure; call
|
||||
* SDL_GetError() for more information.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_GetGlobalProperties")] public static extern PropertiesID GetGlobalProperties();
|
||||
|
||||
/**
|
||||
* Create a group of properties.
|
||||
*
|
||||
* All properties are automatically destroyed when SDL_Quit() is called.
|
||||
*
|
||||
* \returns an ID for a new group of properties, or 0 on failure; call
|
||||
* SDL_GetError() for more information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_DestroyProperties
|
||||
*/
|
||||
[LinkName("SDL_CreateProperties")] public static extern PropertiesID CreateProperties();
|
||||
|
||||
/**
|
||||
* Copy a group of properties.
|
||||
*
|
||||
* Copy all the properties from one group of properties to another, with the
|
||||
* exception of properties requiring cleanup (set using
|
||||
* SDL_SetPointerPropertyWithCleanup()), which will not be copied. Any
|
||||
* property that already exists on `dst` will be overwritten.
|
||||
*
|
||||
* \param src the properties to copy.
|
||||
* \param dst the destination properties.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread. This
|
||||
* function acquires simultaneous mutex locks on both the source
|
||||
* and destination property sets.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_CopyProperties")] public static extern bool CopyProperties(PropertiesID src, PropertiesID dst);
|
||||
|
||||
/**
|
||||
* Lock a group of properties.
|
||||
*
|
||||
* Obtain a multi-threaded lock for these properties. Other threads will wait
|
||||
* while trying to lock these properties until they are unlocked. Properties
|
||||
* must be unlocked before they are destroyed.
|
||||
*
|
||||
* The lock is automatically taken when setting individual properties, this
|
||||
* function is only needed when you want to set several properties atomically
|
||||
* or want to guarantee that properties being queried aren't freed in another
|
||||
* thread.
|
||||
*
|
||||
* \param props the properties to lock.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_UnlockProperties
|
||||
*/
|
||||
[LinkName("SDL_LockProperties")] public static extern bool LockProperties(PropertiesID props);
|
||||
|
||||
/**
|
||||
* Unlock a group of properties.
|
||||
*
|
||||
* \param props the properties to unlock.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_LockProperties
|
||||
*/
|
||||
[LinkName("SDL_UnlockProperties")] public static extern void UnlockProperties(PropertiesID props);
|
||||
|
||||
/**
|
||||
* A callback used to free resources when a property is deleted.
|
||||
*
|
||||
* This should release any resources associated with `value` that are no
|
||||
* longer needed.
|
||||
*
|
||||
* This callback is set per-property. Different properties in the same group
|
||||
* can have different cleanup callbacks.
|
||||
*
|
||||
* This callback will be called _during_ SDL_SetPointerPropertyWithCleanup if
|
||||
* the function fails for any reason.
|
||||
*
|
||||
* \param userdata an app-defined pointer passed to the callback.
|
||||
* \param value the pointer assigned to the property to clean up.
|
||||
*
|
||||
* \threadsafety This callback may fire without any locks held; if this is a
|
||||
* concern, the app should provide its own locking.
|
||||
*
|
||||
* \since This datatype is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_SetPointerPropertyWithCleanup
|
||||
*/
|
||||
public function void CleanupPropertyCallback(void* userdata, void* value);
|
||||
|
||||
/**
|
||||
* Set a pointer property in a group of properties with a cleanup function
|
||||
* that is called when the property is deleted.
|
||||
*
|
||||
* The cleanup function is also called if setting the property fails for any
|
||||
* reason.
|
||||
*
|
||||
* For simply setting basic data types, like numbers, bools, or strings, use
|
||||
* SDL_SetNumberProperty, SDL_SetBooleanProperty, or SDL_SetStringProperty
|
||||
* instead, as those functions will handle cleanup on your behalf. This
|
||||
* function is only for more complex, custom data.
|
||||
*
|
||||
* \param props the properties to modify.
|
||||
* \param name the name of the property to modify.
|
||||
* \param value the new value of the property, or NULL to delete the property.
|
||||
* \param cleanup the function to call when this property is deleted, or NULL
|
||||
* if no cleanup is necessary.
|
||||
* \param userdata a pointer that is passed to the cleanup function.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetPointerProperty
|
||||
* \sa SDL_SetPointerProperty
|
||||
* \sa SDL_CleanupPropertyCallback
|
||||
*/
|
||||
[LinkName("SDL_SetPointerPropertyWithCleanup")] public static extern bool SetPointerPropertyWithCleanup(PropertiesID props, c_char* name, void* value, CleanupPropertyCallback cleanup, void* userdata);
|
||||
|
||||
/**
|
||||
* Set a pointer property in a group of properties.
|
||||
*
|
||||
* \param props the properties to modify.
|
||||
* \param name the name of the property to modify.
|
||||
* \param value the new value of the property, or NULL to delete the property.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetPointerProperty
|
||||
* \sa SDL_HasProperty
|
||||
* \sa SDL_SetBooleanProperty
|
||||
* \sa SDL_SetFloatProperty
|
||||
* \sa SDL_SetNumberProperty
|
||||
* \sa SDL_SetPointerPropertyWithCleanup
|
||||
* \sa SDL_SetStringProperty
|
||||
*/
|
||||
[LinkName("SDL_SetPointerProperty")] public static extern bool SetPointerProperty(PropertiesID props, c_char* name, void* value);
|
||||
|
||||
/**
|
||||
* Set a string property in a group of properties.
|
||||
*
|
||||
* This function makes a copy of the string; the caller does not have to
|
||||
* preserve the data after this call completes.
|
||||
*
|
||||
* \param props the properties to modify.
|
||||
* \param name the name of the property to modify.
|
||||
* \param value the new value of the property, or NULL to delete the property.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetStringProperty
|
||||
*/
|
||||
[LinkName("SDL_SetStringProperty")] public static extern bool SetStringProperty(PropertiesID props, c_char* name, c_char* value);
|
||||
|
||||
/**
|
||||
* Set an integer property in a group of properties.
|
||||
*
|
||||
* \param props the properties to modify.
|
||||
* \param name the name of the property to modify.
|
||||
* \param value the new value of the property.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetNumberProperty
|
||||
*/
|
||||
[LinkName("SDL_SetNumberProperty")] public static extern bool SetNumberProperty(PropertiesID props, c_char* name, Sint64 value);
|
||||
|
||||
/**
|
||||
* Set a floating point property in a group of properties.
|
||||
*
|
||||
* \param props the properties to modify.
|
||||
* \param name the name of the property to modify.
|
||||
* \param value the new value of the property.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetFloatProperty
|
||||
*/
|
||||
[LinkName("SDL_SetFloatProperty")] public static extern bool SetFloatProperty(PropertiesID props, c_char* name, float value);
|
||||
|
||||
/**
|
||||
* Set a boolean property in a group of properties.
|
||||
*
|
||||
* \param props the properties to modify.
|
||||
* \param name the name of the property to modify.
|
||||
* \param value the new value of the property.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetBooleanProperty
|
||||
*/
|
||||
[LinkName("SDL_SetBooleanProperty")] public static extern bool SetBooleanProperty(PropertiesID props, c_char* name, bool value);
|
||||
|
||||
/**
|
||||
* Return whether a property exists in a group of properties.
|
||||
*
|
||||
* \param props the properties to query.
|
||||
* \param name the name of the property to query.
|
||||
* \returns true if the property exists, or false if it doesn't.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetPropertyType
|
||||
*/
|
||||
[LinkName("SDL_HasProperty")] public static extern bool HasProperty(PropertiesID props, c_char* name);
|
||||
|
||||
/**
|
||||
* Get the type of a property in a group of properties.
|
||||
*
|
||||
* \param props the properties to query.
|
||||
* \param name the name of the property to query.
|
||||
* \returns the type of the property, or SDL_PROPERTY_TYPE_INVALID if it is
|
||||
* not set.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_HasProperty
|
||||
*/
|
||||
[LinkName("SDL_GetPropertyType")] public static extern PropertyType GetPropertyType(PropertiesID props, c_char* name);
|
||||
|
||||
/**
|
||||
* Get a pointer property from a group of properties.
|
||||
*
|
||||
* By convention, the names of properties that SDL exposes on objects will
|
||||
* start with "SDL.", and properties that SDL uses internally will start with
|
||||
* "SDL.internal.". These should be considered read-only and should not be
|
||||
* modified by applications.
|
||||
*
|
||||
* \param props the properties to query.
|
||||
* \param name the name of the property to query.
|
||||
* \param default_value the default value of the property.
|
||||
* \returns the value of the property, or `default_value` if it is not set or
|
||||
* not a pointer property.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread, although
|
||||
* the data returned is not protected and could potentially be
|
||||
* freed if you call SDL_SetPointerProperty() or
|
||||
* SDL_ClearProperty() on these properties from another thread.
|
||||
* If you need to avoid this, use SDL_LockProperties() and
|
||||
* SDL_UnlockProperties().
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetBooleanProperty
|
||||
* \sa SDL_GetFloatProperty
|
||||
* \sa SDL_GetNumberProperty
|
||||
* \sa SDL_GetPropertyType
|
||||
* \sa SDL_GetStringProperty
|
||||
* \sa SDL_HasProperty
|
||||
* \sa SDL_SetPointerProperty
|
||||
*/
|
||||
[LinkName("SDL_GetPointerProperty")] public static extern void* GetPointerProperty(PropertiesID props, c_char* name, void* default_value);
|
||||
|
||||
/**
|
||||
* Get a string property from a group of properties.
|
||||
*
|
||||
* \param props the properties to query.
|
||||
* \param name the name of the property to query.
|
||||
* \param default_value the default value of the property.
|
||||
* \returns the value of the property, or `default_value` if it is not set or
|
||||
* not a string property.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread, although
|
||||
* the data returned is not protected and could potentially be
|
||||
* freed if you call SDL_SetStringProperty() or
|
||||
* SDL_ClearProperty() on these properties from another thread.
|
||||
* If you need to avoid this, use SDL_LockProperties() and
|
||||
* SDL_UnlockProperties().
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetPropertyType
|
||||
* \sa SDL_HasProperty
|
||||
* \sa SDL_SetStringProperty
|
||||
*/
|
||||
[LinkName("SDL_GetStringProperty")] public static extern c_char* GetStringProperty(PropertiesID props, c_char* name, c_char* default_value);
|
||||
|
||||
/**
|
||||
* Get a number property from a group of properties.
|
||||
*
|
||||
* You can use SDL_GetPropertyType() to query whether the property exists and
|
||||
* is a number property.
|
||||
*
|
||||
* \param props the properties to query.
|
||||
* \param name the name of the property to query.
|
||||
* \param default_value the default value of the property.
|
||||
* \returns the value of the property, or `default_value` if it is not set or
|
||||
* not a number property.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetPropertyType
|
||||
* \sa SDL_HasProperty
|
||||
* \sa SDL_SetNumberProperty
|
||||
*/
|
||||
[LinkName("SDL_GetNumberProperty")] public static extern Sint64 GetNumberProperty(PropertiesID props, c_char* name, Sint64 default_value);
|
||||
|
||||
/**
|
||||
* Get a floating point property from a group of properties.
|
||||
*
|
||||
* You can use SDL_GetPropertyType() to query whether the property exists and
|
||||
* is a floating point property.
|
||||
*
|
||||
* \param props the properties to query.
|
||||
* \param name the name of the property to query.
|
||||
* \param default_value the default value of the property.
|
||||
* \returns the value of the property, or `default_value` if it is not set or
|
||||
* not a float property.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetPropertyType
|
||||
* \sa SDL_HasProperty
|
||||
* \sa SDL_SetFloatProperty
|
||||
*/
|
||||
[LinkName("SDL_GetFloatProperty")] public static extern float GetFloatProperty(PropertiesID props, c_char* name, float default_value);
|
||||
|
||||
/**
|
||||
* Get a boolean property from a group of properties.
|
||||
*
|
||||
* You can use SDL_GetPropertyType() to query whether the property exists and
|
||||
* is a boolean property.
|
||||
*
|
||||
* \param props the properties to query.
|
||||
* \param name the name of the property to query.
|
||||
* \param default_value the default value of the property.
|
||||
* \returns the value of the property, or `default_value` if it is not set or
|
||||
* not a boolean property.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_GetPropertyType
|
||||
* \sa SDL_HasProperty
|
||||
* \sa SDL_SetBooleanProperty
|
||||
*/
|
||||
[LinkName("SDL_GetBooleanProperty")] public static extern bool GetBooleanProperty(PropertiesID props, c_char* name, bool default_value);
|
||||
|
||||
/**
|
||||
* Clear a property from a group of properties.
|
||||
*
|
||||
* \param props the properties to modify.
|
||||
* \param name the name of the property to clear.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_ClearProperty")] public static extern bool ClearProperty(PropertiesID props, c_char* name);
|
||||
|
||||
/**
|
||||
* A callback used to enumerate all the properties in a group of properties.
|
||||
*
|
||||
* This callback is called from SDL_EnumerateProperties(), and is called once
|
||||
* per property in the set.
|
||||
*
|
||||
* \param userdata an app-defined pointer passed to the callback.
|
||||
* \param props the SDL_PropertiesID that is being enumerated.
|
||||
* \param name the next property name in the enumeration.
|
||||
*
|
||||
* \threadsafety SDL_EnumerateProperties holds a lock on `props` during this
|
||||
* callback.
|
||||
*
|
||||
* \since This datatype is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_EnumerateProperties
|
||||
*/
|
||||
public function void EnumeratePropertiesCallback(void* userdata, PropertiesID props, c_char* name);
|
||||
|
||||
/**
|
||||
* Enumerate the properties contained in a group of properties.
|
||||
*
|
||||
* The callback function is called for each property in the group of
|
||||
* properties. The properties are locked during enumeration.
|
||||
*
|
||||
* \param props the properties to query.
|
||||
* \param callback the function to call for each property.
|
||||
* \param userdata a pointer that is passed to `callback`.
|
||||
* \returns true on success or false on failure; call SDL_GetError() for more
|
||||
* information.
|
||||
*
|
||||
* \threadsafety It is safe to call this function from any thread.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*/
|
||||
[LinkName("SDL_EnumerateProperties")] public static extern bool EnumerateProperties(PropertiesID props, EnumeratePropertiesCallback callback, void* userdata);
|
||||
|
||||
/**
|
||||
* Destroy a group of properties.
|
||||
*
|
||||
* All properties are deleted and their cleanup functions will be called, if
|
||||
* any.
|
||||
*
|
||||
* \param props the properties to destroy.
|
||||
*
|
||||
* \threadsafety This function should not be called while these properties are
|
||||
* locked or other threads might be setting or getting values
|
||||
* from these properties.
|
||||
*
|
||||
* \since This function is available since SDL 3.2.0.
|
||||
*
|
||||
* \sa SDL_CreateProperties
|
||||
*/
|
||||
[LinkName("SDL_DestroyProperties")] public static extern void DestroyProperties(PropertiesID props);
|
||||
}
|
||||
|
||||
/* Ends C function definitions when using C++ */
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/* SDL_properties_h_ */
|
||||
Reference in New Issue
Block a user