Class Sdl.Metadata
- Namespace
- Sdl3Sharp
- Assembly
- Sdl3Sharp.dll
Provides predefined metadata names for GetMetadata(string) and the *SetMetadata methods on a Sdl.Builder
public static class Sdl.Metadata- Inheritance
-
Sdl.Metadata
- Inherited Members
Fields
Copyright
The human-readable copyright notice
public const string Copyright = "SDL.app.metadata.copyright"Field Value
Remarks
The copyright notice, like "Copyright (c) 2024 MojoWorkshop, LLC" or whatnot.
Keep the metadata to one line, don't paste a copy of a whole software license in here.
The metadata has no default.
Creator
The human-readable name of the creator/developer/maker of this app
public const string Creator = "SDL.app.metadata.creator"Field Value
Remarks
The name of the creator/developer/maker of this app like "MojoWorkshop, LLC"
Identifier
A unique string that identifies this app
public const string Identifier = "SDL.app.metadata.identifier"Field Value
Remarks
The metadata must be in reverse-domain format, like "com.example.mygame2".
The metadata is used by desktop compositors to identify and group windows together, as well as match applications with associated desktop settings and icons.
If you plan to package your application in a container such as Flatpak, the app ID should match the name of your Flatpak container as well.
The metadata has no default.
Name
The human-readable name of the application
public const string Name = "SDL.app.metadata.name"Field Value
Remarks
The name of the app, like "My Game 2: Bad Guy's Revenge!".
The metadata will show up anywhere the OS shows the name of the application separately from window titles, such as volume control applets, etc.
The metadata defaults to "SDL Application".
Type
The type of application
public const string Type = "SDL.app.metadata.type"Field Value
Remarks
Currently the metadata can be "game" for a video game, "mediaplayer" for a media player, or generically "application" if nothing else applies.
Future versions of SDL might add new types.
The metadata defaults to "application".
Url
A URL to the app on the web.
public const string Url = "SDL.app.metadata.url"Field Value
Remarks
The URL maybe a product page, or a storefront, or even a GitHub repository, for user's further information. The metadata has no default.
Version
The version of the app
public const string Version = "SDL.app.metadata.version"Field Value
Remarks
There are no rules on format, so "1.0.3beta2" and "April 22nd, 2024" and a git hash are all valid options.
The metadata has no default.