Skip to content

SdlSetAppMetadata

Specify basic metadata about your app.

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 empty, if a specific detail doesn't make sense for the app.

This function should be called as early as possible, before 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 an empty string removes any previous metadata.

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

Definition

Unit: Neslib.Sdl3.Basics

procedure SdlSetAppMetadata(const AAppName, AAppVersion, 
  AAppIdentifier: String); overload; inline

Parameters

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

AAppVersion: String : The version of the application ('1.0.0beta5' or a git hash, or whatever makes sense).

AAppIdentifier: String : A unique string in reverse-domain format that identifies this app ('com.example.mygame2').

Exceptions

ESdlError: Raised on failure.

See Also

Remarks

It is safe to call this routine from any thread.