sdl3-src 3.4.4

Source code of the SDL 3 library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

/*
  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.
*/
// This is included in SDL_internal.h
//#include "SDL_internal.h"

#ifndef SDL_utils_h_
#define SDL_utils_h_

// Common utility functions that aren't in the public API

// Return the smallest power of 2 greater than or equal to 'x'
extern int SDL_powerof2(int x);

extern Uint32 SDL_CalculateGCD(Uint32 a, Uint32 b);
extern void SDL_CalculateFraction(float x, int *numerator, int *denominator);

extern bool SDL_startswith(const char *string, const char *prefix);
extern bool SDL_endswith(const char *string, const char *suffix);

/** Convert URI to a local filename, stripping the "file://"
 *  preamble and hostname if present, and writes the result
 *  to the dst buffer. Since URI-encoded characters take
 *  three times the space of normal characters, src and dst
 *  can safely point to the same buffer for in situ conversion.
 *
 *  Returns the number of decoded bytes that wound up in
 *  the destination buffer, excluding the terminating NULL byte.
 *
 *  On error, -1 is returned.
 */
extern int SDL_URIToLocal(const char *src, char *dst);

typedef enum
{
    SDL_OBJECT_TYPE_UNKNOWN,
    SDL_OBJECT_TYPE_WINDOW,
    SDL_OBJECT_TYPE_RENDERER,
    SDL_OBJECT_TYPE_TEXTURE,
    SDL_OBJECT_TYPE_JOYSTICK,
    SDL_OBJECT_TYPE_GAMEPAD,
    SDL_OBJECT_TYPE_HAPTIC,
    SDL_OBJECT_TYPE_SENSOR,
    SDL_OBJECT_TYPE_HIDAPI_DEVICE,
    SDL_OBJECT_TYPE_HIDAPI_JOYSTICK,
    SDL_OBJECT_TYPE_THREAD,
    SDL_OBJECT_TYPE_TRAY,

} SDL_ObjectType;

extern Uint32 SDL_GetNextObjectID(void);
extern void SDL_SetObjectValid(void *object, SDL_ObjectType type, bool valid);
extern bool SDL_FindObject(void *object, SDL_ObjectType type);
extern int SDL_GetObjects(SDL_ObjectType type, void **objects, int count);
extern void SDL_SetObjectsInvalid(void);

extern bool SDL_object_validation;

SDL_FORCE_INLINE bool SDL_ObjectValid(void *object, SDL_ObjectType type)
{
    if (!object) {
        return false;
    }

    if (!SDL_object_validation) {
        return true;
    }

    return SDL_FindObject(object, type);
}

extern const char *SDL_GetPersistentString(const char *string);

extern char *SDL_CreateDeviceName(Uint16 vendor, Uint16 product, const char *vendor_name, const char *product_name, const char *default_name);

// Log what backend a subsystem chose, if a hint was set to do so. Useful for debugging.
extern void SDL_DebugLogBackend(const char *subsystem, const char *backend);

#ifdef SDL_PLATFORM_EMSCRIPTEN
// even though we reference the C runtime's free() in other places, it appears
// to be inlined more aggressively in Emscripten 4, so we need a reference to
// it here, too, so inlined Javascript doesn't fail to find it.
extern void Emscripten_force_free(void *ptr);
#endif

#endif // SDL_utils_h_