1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>
4
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
8
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
12
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
20*/
21
22/**
23 * \file SDL_guid.h
24 *
25 * Include file for handling ::SDL_GUID values.
26 */
27
28#ifndef SDL_guid_h_
29#define SDL_guid_h_
30
31#include "SDL_stdinc.h"
32#include "SDL_error.h"
33
34#include "begin_code.h"
35/* Set up for C function definitions, even when using C++ */
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40/**
41 * An SDL_GUID is a 128-bit identifier for an input device that
42 * identifies that device across runs of SDL programs on the same
43 * platform. If the device is detached and then re-attached to a
44 * different port, or if the base system is rebooted, the device
45 * should still report the same GUID.
46 *
47 * GUIDs are as precise as possible but are not guaranteed to
48 * distinguish physically distinct but equivalent devices. For
49 * example, two game controllers from the same vendor with the same
50 * product ID and revision may have the same GUID.
51 *
52 * GUIDs may be platform-dependent (i.e., the same device may report
53 * different GUIDs on different operating systems).
54 */
55typedef struct {
56 Uint8 data[16];
57} SDL_GUID;
58
59/* Function prototypes */
60
61/**
62 * Get an ASCII string representation for a given ::SDL_GUID.
63 *
64 * You should supply at least 33 bytes for pszGUID.
65 *
66 * \param guid the ::SDL_GUID you wish to convert to string
67 * \param pszGUID buffer in which to write the ASCII string
68 * \param cbGUID the size of pszGUID
69 *
70 * \since This function is available since SDL 2.24.0.
71 *
72 * \sa SDL_GUIDFromString
73 */
74extern DECLSPEC void SDLCALL SDL_GUIDToString(SDL_GUID guid, char *pszGUID, int cbGUID);
75
76/**
77 * Convert a GUID string into a ::SDL_GUID structure.
78 *
79 * Performs no error checking. If this function is given a string containing
80 * an invalid GUID, the function will silently succeed, but the GUID generated
81 * will not be useful.
82 *
83 * \param pchGUID string containing an ASCII representation of a GUID
84 * \returns a ::SDL_GUID structure.
85 *
86 * \since This function is available since SDL 2.24.0.
87 *
88 * \sa SDL_GUIDToString
89 */
90extern DECLSPEC SDL_GUID SDLCALL SDL_GUIDFromString(const char *pchGUID);
91
92/* Ends C function definitions when using C++ */
93#ifdef __cplusplus
94}
95#endif
96#include "close_code.h"
97
98#endif /* SDL_guid_h_ */
99
100/* vi: set ts=4 sw=4 expandtab: */
101