gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source 
[ci skip]
This commit is contained in:
SDL Wiki Bot
2025-04-03 15:53:43 +00:00
parent f78aa4d8ea
commit 25232c077d
1 changed files with 32 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
include/SDL3/SDL_gpu.h
View File

@@ -2262,19 +2262,21 @@ extern SDL_DECLSPEC SDL_GPUShaderFormat SDLCALL SDL_GetGPUShaderFormats(SDL_GPUD
/** /**
* Returns a property group containing read-only debug information associated * Returns a property group containing read-only debug information associated
* with this GPU context. All properties are optionally provided and may differ * with this GPU context.
* between GPU backends and SDL versions. *
* All properties are optionally provided and may differ between GPU backends
* and SDL versions.
* *
* The following properties are provided by SDL: * The following properties are provided by SDL:
* *
* ### `SDL_PROP_GPU_DEVICE_DEBUG_NAME_STRING` * ### `SDL_PROP_GPU_DEVICE_DEBUG_NAME_STRING`
* *
* Contains the name of the underlying device as reported by the system driver. * Contains the name of the underlying device as reported by the system
* This string has no standardized format, is highly inconsistent between * driver. This string has no standardized format, is highly inconsistent
* hardware devices and drivers, and is able to change at any time. Do not * between hardware devices and drivers, and is able to change at any time. Do
* attempt to parse this string as it is bound to fail at some point in the * not attempt to parse this string as it is bound to fail at some point in
* future when system drivers are updated, new hardware devices are introduced, * the future when system drivers are updated, new hardware devices are
* or when SDL adds new GPU backends or modifies existing ones. * introduced, or when SDL adds new GPU backends or modifies existing ones.
* *
* Strings that have been found in the wild include: * Strings that have been found in the wild include:
* *
@@ -2297,12 +2299,12 @@ extern SDL_DECLSPEC SDL_GPUShaderFormat SDLCALL SDL_GetGPUShaderFormats(SDL_GPUD
* - unknown device * - unknown device
* *
* The above list shows that the same device can have different formats, the * The above list shows that the same device can have different formats, the
* vendor name may or may not appear in the string, the included vendor name may * vendor name may or may not appear in the string, the included vendor name
* not be the vendor of the chipset on the device, some manufacturers include * may not be the vendor of the chipset on the device, some manufacturers
* pseudo-legal marks while others don't, some devices may not use a marketing * include pseudo-legal marks while others don't, some devices may not use a
* name in the string, the device string may be wrapped by the name of a * marketing name in the string, the device string may be wrapped by the name
* translation interface, the device may be emulated in software, or the string * of a translation interface, the device may be emulated in software, or the
* may contain generic text that does not identify the device at all. * string may contain generic text that does not identify the device at all.
* *
* ### `SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_NAME_STRING` * ### `SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_NAME_STRING`
* *
@@ -2319,11 +2321,11 @@ extern SDL_DECLSPEC SDL_GPUShaderFormat SDLCALL SDL_GetGPUShaderFormats(SDL_GPUD
* *
* ### `SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_VERSION_STRING` * ### `SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_VERSION_STRING`
* *
* Contains the self-reported version of the underlying system driver. This is a * Contains the self-reported version of the underlying system driver. This is
* relatively short version string in an unspecified format. If * a relatively short version string in an unspecified format. If
* SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_INFO_STRING is available then that property * SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_INFO_STRING is available then that
* should be preferred over this one as it may contain additional information * property should be preferred over this one as it may contain additional
* that is useful for identifying the exact driver version used. * information that is useful for identifying the exact driver version used.
* *
* Strings that have been found in the wild include: * Strings that have been found in the wild include:
* *
@@ -2333,11 +2335,12 @@ extern SDL_DECLSPEC SDL_GPUShaderFormat SDLCALL SDL_GetGPUShaderFormats(SDL_GPUD
* *
* ### `SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_INFO_STRING` * ### `SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_INFO_STRING`
* *
* Contains the detailed version information of the underlying system driver as * Contains the detailed version information of the underlying system driver
* reported by the driver. This is an arbitrary string with no standardized * as reported by the driver. This is an arbitrary string with no standardized
* format and it may contain newlines. This property should be preferred over * format and it may contain newlines. This property should be preferred over
* SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_VERSION_STRING if it is available as it * SDL_PROP_GPU_DEVICE_DEBUG_DRIVER_VERSION_STRING if it is available as it
* usually contains the same information but in a format that is easier to read. * usually contains the same information but in a format that is easier to
* read.
* *
* Strings that have been found in the wild include: * Strings that have been found in the wild include:
* *
@@ -2359,8 +2362,8 @@ extern SDL_DECLSPEC SDL_GPUShaderFormat SDLCALL SDL_GetGPUShaderFormats(SDL_GPUD
* ### `SDL_PROP_GPU_DEVICE_DEBUG_VULKAN_CONFORMANCE_STRING` * ### `SDL_PROP_GPU_DEVICE_DEBUG_VULKAN_CONFORMANCE_STRING`
* *
* When using the Vulkan backend, contains the highest Vulkan version number * When using the Vulkan backend, contains the highest Vulkan version number
* that the system driver claims that the underlying hardware conforms to. This * that the system driver claims that the underlying hardware conforms to.
* is self-reported and may not be truthful. * This is self-reported and may not be truthful.
* *
* Strings that have been found in the wild include: * Strings that have been found in the wild include:
* *
@@ -2369,10 +2372,11 @@ extern SDL_DECLSPEC SDL_GPUShaderFormat SDLCALL SDL_GetGPUShaderFormats(SDL_GPUD
* - 1.3.8.2 * - 1.3.8.2
* *
* \param device a GPU context to query. * \param device a GPU context to query.
* \returns a valid property ID or 0. A value of 0 indicates that no properties * \returns a valid property ID or 0. A value of 0 indicates that no
* are available and is not an error. The returned property group is * properties are available and is not an error. The returned
* owned by SDL and has the same lifetime as the containing context. It * property group is owned by SDL and has the same lifetime as the
* should not be destroyed manually when no longer needed. * containing context. It should not be destroyed manually when no
* longer needed.
* *
* \since This function is available since SDL 3.4.0. * \since This function is available since SDL 3.4.0.
*/ */