NAME¶

SDL_SetAppMetadata - Specify basic metadata about your app.

HEADER FILE¶

Defined in SDL3/SDL_init.h

SYNOPSIS¶

#include "SDL3/SDL.h"

bool SDL_SetAppMetadata(const char *appname, const char *appversion, const char *appidentifier);

DESCRIPTION¶

You can optionally provide metadata about your app to SDL. This is not required, but strongly encouraged.

There are several locations where SDL can make use of metadata (an "About" box in the macOS menu bar, the name of the app can be shown on some audio mixers, etc). Any piece of metadata can be left as NULL, if a specific detail doesn't make sense for the app.

This function should be called as early as possible, before

SDL_Init . Multiple calls to this function are allowed, but various state might not change once it has been set up with a previous call to this function.

Passing a NULL removes any previous metadata.

This is a simplified interface for the most important information. You can supply significantly more detailed metadata with

SDL_SetAppMetadataProperty ().

FUNCTION PARAMETERS¶

appname

The name of the application ("My Game 2: Bad Guy's Revenge!").

appversion

The version of the application ("1.0.0beta5" or a git hash, or whatever makes sense).

appidentifier

A unique string in reverse-domain format that identifies this app ("com.example.mygame2").

RETURN VALUE¶

Returns true on success or false on failure; call

SDL_GetError () for more information.

THREAD SAFETY¶

It is safe to call this function from any thread.

AVAILABILITY¶

This function is available since SDL 3.1.3.

SEE ALSO¶

•(3), SDL_SetAppMetadataProperty(3)