Grænseflade, som giver adgang til en række forskellige hjælpefunktioner.

Medlemsfunktioner

Medlemsfunktioner for ISteamUtils kaldes gennem den globale accessor-funktion SteamUtils().

BOverlayNeedsPresent

Tjekker, om overlayet skal være til stede. Kun påkrævet, hvis der bruges hændelsesstyrede gengivelsesopdateringer.

Dette kald er som regel unødvendigt, hvis dit spil konstant kører et frame loop, der kalder D3D Present-API'en eller OGL SwapBuffers-API'en i hvert billede, hvilket gælder de fleste spil. Men hvis du har et spil, som kun opdaterer skærmen på en hændelsesstyret basis, kan det ødelægge overlayet, da det bruger dine Present-/SwapBuffers-kald til at køre det interne frame loop, og det har evt. også brug for Present() til skærmen, når der er en notifikation, eller når overlayet bringes frem oven på spillet af brugeren. I så tilfælde kan du bruge denne API til at spørge overlayet, om det har brug for Present i øjeblikket, og derefter kan du tjekke det med jævne mellemrum (ca. 33 Hz er godt) og sikre, at du opdaterer skærmen med Present eller SwapBuffers, så overlayet kan gøre det, det skal.

Returværdier: bool
true hvis overlayet har brug for, at du opdaterer skærmen, ellers false.

CheckFileSignature

Navn	Type	Beskrivelse
szFileName	const char *	.

Forældet.

Returværdier: SteamAPICall_t, som skal bruges med et CheckFileSignature_t-kaldsresultat.

GetAPICallFailureReason

Navn	Type	Beskrivelse
hSteamAPICall	SteamAPICall_t	Handle for Steam-API-kaldet, hvis fejl der skal tjekkes.

Bruges til at hente fejlårsagen for et kaldsresultat.

Denne funktion bruges primært til fejlfinding. Fejlårsagerne ligger som regel uden for din kontrol og er sjældent særlig vigtige. Bare bliv ved med at prøve med dit API-kald, indtil det virker.

Returværdier: ESteamAPICallFailure
[type]ESteamAPICallFailure[/type]

Se også: IsAPICallCompleted, GetAPICallResult

Eksempel:

GetAPICallResult

Navn	Type	Beskrivelse
hSteamAPICall	SteamAPICall_t	Handlet til API-kaldet.
pCallback	void *	Returnerer tilbagekaldet til den forudallokerede hukommelse, der er angivet.
cubCallback	int	Størrelsen af pCallback, som du sender.
iCallbackExpected	int	k_iCallback-tallet, som er tilknyttet tilbagekaldet.
pbFailed	bool *	Returnerer, hvis API-kaldet støder på en fejl.

Henter indholdet i et gennemført API-kald. Gives til backenden af CallResult-wrapperen.

Generelt anbefales det ikke, at du bruger dette manuelt.

Returværdier: bool
true hvis kaldet lykkes, hvis API-kaldet er gyldigt og er blevet gennemført, ellers false.

Hvis kaldet lykkes, kopierer det tilbagekaldet ind i pCallback og returnerer fejl i pbFailed.

Se også: IsAPICallCompleted, GetAPICallFailureReason

GetAppID

Henter app-ID'et for den aktuelle proces.

Returværdier: uint32
– returnerer app-ID'et.

GetConnectedUniverse

Henter det univers, som den aktuelle klient opretter forbindelse til. (Bruges udelukkende af Valve).

Returværdier: EUniverse
[type]EUniverse[/type]

GetCSERIPPort

Navn	Type	Beskrivelse
unIP	uint32 *	Returnerer den IP, som klienten er forbundet til.
usPort	uint16 *	Returnerer den port, som klienten er forbundet til.

Henter IP'en for rapporteringsserveren for Valve – bruges i øjeblikket kun i Source Engine-spil.

Returværdier: bool
Returnerer true, hvis brugeren er forbundet i øjeblikket, ellers false.

GetCurrentBatteryPower

Henter den aktuelle mængde strøm på computerens batteri.

Returværdier: uint8
Den aktuelle mængde strøm på batteriet inden for mellem [0..100]%. Returnerer 255, når brugeren anvender strømnettet.

GetEnteredGamepadTextInput

Navn	Type	Beskrivelse
pchText	char *	En forudallokeret buffer, som tekstinputstrengen skal kopieres ind i.
cchText	uint32	Størrelsen af pchText-bufferen.

Henter gamepad-tekstinput fra Big Picture-overlayet.

Dette skal kaldes inden for GamepadTextInputDismissed_t-tilbagekaldet, og kun hvis GamepadTextInputDismissed_t.m_bSubmitted er true.

Viser tekstinputtet som UTF-8.

Returværdier: bool
true, hvis der var tekst, der kunne modtages, og cchText er samme størrelse som GamepadTextInputDismissed_t.m_unSubmittedText – ellers false.

Se også: ShowGamepadTextInput, GetEnteredGamepadTextLength

Eksempel:

GetEnteredGamepadTextLength

Henter længden af gamepad-tekstinputtet fra Big Picture-overlayet.

Dette skal kaldes inden for GamepadTextInputDismissed_t-tilbagekaldet, og kun hvis GamepadTextInputDismissed_t.m_bSubmitted er true.

Returværdier: uint32


Se også: ShowGamepadTextInput, GetEnteredGamepadTextInput

Eksempel:

GetImageRGBA

Navn	Type	Beskrivelse
iImage	int	Handlet til det billede, der skal hentes.
pubDest	uint8 *	Bufferen, som vil blive fyldt.
nDestBufferSize	int	Den samlede størrelse af pubDest-bufferen.

Henter billed-bytes fra et billed-handle.

Inden dette kaldes, skal du hente størrelsen af billedet ved at kalde GetImageSize, så du kan oprette en buffer i den rigtige størrelse. Du kan derefter allokere bufferen med denne bredde og højde: bredde * højde * 4. Billedet leveres i RGBA-format. Dette kan kan være lidt resursetungt, da det konverterer fra den komprimerede type (JPG, PNG, TGA) og ikke leverer nogen intern cachelagring for den returnerede buffer. Derfor anbefales det kraftigt kun at kalde dette én gang pr. billed-handle og cachelagre resultatet. Denne funktion bruges kun for Steam-avatarer og præstationsbilleder, og de forventes ikke at ændre sig midt i spillet.

Returværdier: bool
true, hvis kaldet lykkes, hvis billed-handlet er gyldigt, og bufferen var helt fuld, ellers false.

Se også: ISteamFriends::GetSmallFriendAvatar, ISteamFriends::GetMediumFriendAvatar, ISteamFriends::GetLargeFriendAvatar, ISteamUserStats::GetAchievementIcon

Eksempel:

GetImageSize

Navn	Type	Beskrivelse
iImage	int	Billed-handle, som der skal hentes størrelse på.
pnWidth	uint32 *	Returnerer billedets bredde.
pnHeight	uint32 *	Returnerer billedets højde.

Henter størrelsen på et Steam-billed-handle.

Denne skal kaldes, inden GetImageRGBA kaldes for at oprette en buffer i passende størrelse, som skal fyldes med de rå billeddata.

Returværdier: bool
true, hvis kaldet lykkes, hvis billed-handlet er gyldigt, og størrelserne var fyldt ud, ellers false.

Se også: ISteamFriends::GetSmallFriendAvatar, ISteamFriends::GetMediumFriendAvatar, ISteamFriends::GetLargeFriendAvatar, ISteamUserStats::GetAchievementIcon

GetIPCCallCount

Returnerer antallet af IPC-kald, som er foretaget siden sidste gang, denne funktion blev kaldt.

Bruges til fejlfinding, så du kan se, hvor mange IPC-kald (Inter-Process Communication) dit spil foretager pr. billede
Hvert IPC-kald er mindst et trådkontekstskift, hvis ikke det er et processkift, så du skal vurdere, hvor ofte du vil udføre dem.

Returværdier: uint32

GetIPCountry

Returnerer den tocifrede ISO 3166-1-alpha-2-formaterede landekode, som klienten kører med.
e.g "US" eller "UK".

Dette slås op via en IP-to-location-database.

Returværdier: const char *

GetSecondsSinceAppActive

Returnerer antal sekunder, siden applikationen var aktiv.

Returværdier: uint32

GetSecondsSinceComputerActive

Returnerer antal sekunder, siden brugeren sidst flyttede musen.

Returværdier: uint32

GetServerRealTime

Returnerer Steam-servertiden i Unix Epoch-format (antal sekunder siden 1. januar 1970 UTC).

Returværdier: uint32

GetSteamUILanguage

Returnerer det sprog, Steam-klienten kører på.

Du har sandsynligvis brug for ISteamApps::GetCurrentGameLanguage i stedet, da denne funktion kun bør bruges i meget sjældne tilfælde.

Se en komplet liste over sprog i artiklen om understøttede sprog.

Returværdier: const char *


Se også: ISteamApps::GetCurrentGameLanguage, ISteamApps::GetAvailableGameLanguages

IsAPICallCompleted

Navn	Type	Beskrivelse
hSteamAPICall	SteamAPICall_t	Handle for API-kaldet, som skal tjekkes.
pbFailed	bool *	Returnerer, om API-kaldet er stødt på en fejl (true) eller ej (false).

Tjekker, om et API-kald er udført. Giver backenden af CallResult-wrapperen.

Det anbefales generelt ikke, at du bruger denne selv.

Returværdier: bool
true, hvis API-kaldet er gyldigt og er blevet gennemført, ellers false.

Se også: GetAPICallResult, GetAPICallFailureReason

IsOverlayEnabled

Tjekker, om Steam-overlayet kører, og om brugeren kan tilgå det.

Det kan tage et par sekunder for overlay-processen at starte og tilslutte spilprocessen, så denne funktion vil først returnere false, mens overlayet indlæses.

Returværdier: bool

IsSteamChinaLauncher

Returnerer om det aktuelle startprogram er et Steam China-startprogram. Du kan få klienten til at opføre sig som Steam China-startprogrammet ved at tilføje -dev -steamchina til kommandolinjen, når du kører Steam.

InitFilterText

Initialiserer tekstfiltrering, hvilket indlæser ordbøger i det sprog, som spillet anvender.

Brugere kan tilpasse tekstfiltreringens adfærd i deres Steam-kontopræferencer

Returværdier: bool
true, hvis initialiseringen lykkes, false, hvis filtreringen ikke er tilgængelig på spillets sprog, i hvilket tilfælde FilterText() vil fungere som videregivelse.

Se også: FilterText

FilterText

Navn	Type	Beskrivelse
eContext	ETextFilteringContext	Indholdstypen i inputstrengen
sourceSteamID	CSteamID	Steam-ID'et, som er kilden til inputstrengen (f.eks. spillerens navn eller skrevne chattekst)
pchInputText	const char*	Inputstrengen, der skal filtreres, af typen ASCII eller UTF-8
pchOutFilteredText	char*	Hvor outputtet skal placeres, selv hvis der ikke filtreres
nByteSizeOutFilteredText	uint32	Størrelsen (i bytes) af pchOutFilteredText, bør være mindst strlen(pchInputText)+1

Filtrerer de givne inputbeskeder og placerer de filtrerede resultater i pchOutFilteredText. Juridisk påkrævet filtrering anvendes altid. Afhængigt af konteksten og brugerindstillingerne kan der blive påført yderligere filtrering.

Returværdier: int
Returnerer antallet af tegn (ikke bytes), som blev filtreret.

Se også: InitFilterText

IsSteamInBigPictureMode

Tjekker, om Steam og Steam-overlayet kører i Big Picture-tilstand.

Spil skal startes gennem Steam-klienten for at aktivere Big Picture-overlayet.
Udviklerne kan tilføje spillet som et ikke-Steam-spil til deres bibliotek for at teste denne funktion, mens spillet er under udvikling.

Returværdier: bool
true hvis Big Picture-overlayet er tilgængeligt, ellers false.
Dette returnerer altid false, hvis din app ikke har "spil" angivet som sin applikationstype.

IsSteamRunningInVR

Tjekker, om Steam kører i VR-tilstand.

Returværdier: bool
true hvis Steam kører i VR-tilstand, ellers false.

IsVRHeadsetStreamingEnabled

Tjekker, om HMD'et bliver streamet via Steam Remote Play.

Returværdier: bool
true, hvis VR er slået til, og HMD'et i øjeblikket streames, ellers false.

Se også: SetVRHeadsetStreamingEnabled

IsSteamRunningOnSteamDeck

Tjekker, om Steam kører på en Steam Deck-enhed.

Returværdier: bool
true hvis Steam kører på en Steam Deck-enhed, ellers false.

SetOverlayNotificationInset

Navn	Type	Beskrivelse
nHorizontalInset	int	Den vandrette (venstre-højre) afstand i pixels fra hjørnet.
nVerticalInset	int	Den lodrette (op-ned) afstand i pixels fra hjørnet.

Angiver forskydningen af overlaynotifikationen fra hjørnet angivet af SetOverlayNotificationPosition.

En værdi på (0, 0) nulstiller positionen til hjørnet.

Denne position gælder individuelt for spil og nulstilles ved hver opstart.

SetOverlayNotificationPosition

Navn	Type	Beskrivelse
eNotificationPosition	ENotificationPosition

Angiver, hvilket hjørne, Steams overlaynotifikation skal vises i.

Du kan også angive afstanden fra det valgte hjørne med SetOverlayNotificationInset.

Denne position gælder individuelt for spil og nulstilles ved hver opstart.

SetVRHeadsetStreamingEnabled

Navn	Type	Beskrivelse
bEnabled	bool	Slår streaming af VR HMD til (true) eller fra (false).

Angiver, om HMD-indholdet bliver streamet via Steam Remote Play.

Hvis dette er slået til, så bliver scenen i HMD-headsettet streamet, og fjerninput tillades ikke. Hvis dette er slået fra, vil applikationsvinduet blive streamet i stedet, og fjerninput tillades. Som standard har VR-spil dette slået til, medmindre "VRHeadsetStreaming" "0" er i spillets udvidede appinfo.

Dette er nyttigt i spil, der anvender asymmetrisk multiplayer.

Se også: IsVRHeadsetStreamingEnabled

SetWarningMessageHook

Navn	Type	Beskrivelse
pFunction	SteamAPIWarningMessageHook_t	Funktionspointer til tilbagekaldsfunktionen.

Indstiller en advarselsbesked-hook, som modtager Steam-API-advarsler og informationsbeskeder i tilbagekaldsfunktionen.

Funktionens prototype skal matche definitionen i SteamAPIWarningMessageHook_t. Dette inkluderer den eksterne "C"-binding og kaldekonventionen __cdecl.

"int nSeverity" er niveauet for alvoren: 0 for besked, 1 for advarsel. Hvis du kører ind gennem et fejlfindingsprogram, er det kun advarsler, som sendes. Hvis du tilføjer -debug_steamapi til kommandolinjen, vil informationsbeskeder også blive sendt.
Beskedens tekst er "const char * pchDebugText".
Tilbagekald vil opstå direkte, efter API-funktionen kaldes, som genererede advarslen eller beskeden.

Overførsel af NULL vil unhooke.

Eksempel:

ShowGamepadTextInput

Navn	Type	Beskrivelse
eInputMode	EGamepadTextInputMode	Vælger inputtilstanden, som skal bruges: enten Normal eller Password (skjult tekst)
eLineInputMode	EGamepadTextInputLineMode	Kontrollerer, om der skal bruges input med plads til én eller flere linjer.
pchDescription	const char *	Angiver beskrivelsen, som skal informere brugeren om, hvad dialogboksen til input skal bruges til.
unCharMax	uint32	Det maksimale antal tegn, som brugeren kan indtaste.
pchExistingText	const char *	Angiver den forudeksisterende tekst, som brugeren kan redigere.

Aktiverer Big Picture-tekstinputdialogen, som kun understøtter gamepad-input.

Returværdier: bool
true, hvis Big Picture-overlayet kører, ellers false.

Se også: GetEnteredGamepadTextLength, GetEnteredGamepadTextInput

ShowFloatingGamepadTextInput

Navn	Type	Beskrivelse
eKeyboardMode	EFloatingGamepadTextInputMode	Vælger tastaturtypen, som skal bruges
nTextFieldXPosition	int	X-koordinatet af tekstfeltet, som ikke skal dækkes af det svævende tastatur
nTextFieldYPosition	int	Y-koordinatet af tekstfeltet, som ikke skal dækkes af det svævende tastatur
nTextFieldWidth	int	Bredden af tekstfeltet, som ikke skal dækkes af det svævende tastatur
nTextFieldHeight	int	Højden af tekstfeltet, som ikke skal dækkes af det svævende tastatur

Åbner et svævende tastatur over spilindholdet og sender OS-tastaturtaster direkte til spillet.
Tekstfeltets position angives i pixels i forhold til spilvinduets nulpunkt og bruges til at placere det svævende tastatur på en måde, som ikke dækker tekstfeltet.

Returværdier: bool
true, hvis det svævende tastatur blev vist, ellers false.

Se også: FloatingGamepadTextInputDismissed_t

StartVRDashboard

Beder Steam om at oprette og gengive OpenVR-dashboardet.

SetGameLauncherMode

Navn	Type	Beskrivelse
bLauncherMode	bool	Angiver, om et startprogram er aktivt eller ej

I spilstartprogrammer uden controllerunderstøttelse kan du kalde denne funktion for at få Steam Input til at oversætte controllerinputtet til muse-/tastaturinput til navigation i startprogrammet.

Tilbagekald

Disse er tilbagekald, som kan aktiveres ved at kalde SteamAPI_RunCallbacks. Mange af disse vil blive udløst direkte som svar på medlemsfunktioner tilhørende ISteamUtils.

CheckFileSignature_t

Resultatet af kaldet til CheckFileSignature.

Navn	Type	Beskrivelse
m_eCheckFileSignature	ECheckFileSignature	Indeholder resultaterne af filens signaturtjek. k_ECheckFileSignatureNoSignaturesFoundForThisApp – Denne app er ikke blevet konfigureret under fanen for signatur på partnersiden for at aktivere denne funktion. k_ECheckFileSignatureNoSignaturesFoundForThisFile – Denne fil er ikke på listen under fanen for signatur på partnersiden. k_ECheckFileSignatureFileNotFound– Filen eksisterer ikke på drevet. k_ECheckFileSignatureInvalidSignature – Filen eksisterer, og fanen for signatur er blevet angivet for denne fil, men filen er enten ikke signeret, eller signaturen matcher ikke. k_ECheckFileSignatureValidSignature – Filen er blevet signeret, og signaturen er gyldig.

Tilknyttede funktioner: CheckFileSignature

GamepadTextInputDismissed_t

Kaldes, når gamepadtekstinputtet i Big Picture er blevet lukket.

Navn	Type	Beskrivelse
m_bSubmitted	bool	true, hvis brugeren indtastede og accepterede tekst (kald GetEnteredGamepadTextInput for at hente teksten), ellers false, hvis inputtet blev annulleret.
m_unSubmittedText	uint32	Indeholder længden i bytes, hvis der er blevet indsendt tekst.

FloatingGamepadTextInputDismissed_t

Kaldes, når det svævende tastatur åbnet med ShowFloatingGamepadTextInput er blevet lukket.

IPCountry_t

Kaldes, når brugerens land er blevet ændret. Landet bør opdateres med GetIPCountry.

Dette tilbagekald har ingen felter.

LowBatteryPower_t

Kaldes, når man bruger en bærbar computer, og der er mindre end 10 minutters batteri tilbage. Funktionen aktiveres efterfølgende hvert minut.

Navn	Type	Beskrivelse
m_nMinutesBatteryLeft	uint8	Batteriets estimerede tilbageværende levetid i minutter.

SteamAPICallCompleted_t

Kaldes, når et SteamAPICall_t er gennemført (eller har fejlet)

Navn	Type	Beskrivelse
m_hAsyncCall	SteamAPICall_t	Handlet af Steam-API-kaldet, som er gennemført.
m_iCallback	int	Dette er konstanten k_iCallback, som unikt identificerer hele tilbagekaldet.
m_cubParam	uint32	Størrelsen i bytes af det gennemførte tilbagekald.

AppResumingFromSuspend_t

Dette sendes, når enheden vækkes fra pause/slumretilstand.

Dette tilbagekald har ingen felter.

SteamShutdown_t

Kaldes, når Steam vil lukke.

Dette tilbagekald har ingen felter.

Enums

Disse er optællinger, som defineres til brug med ISteamUtils.

ECheckFileSignature

Resultatet af kaldet til CheckFileSignature

Navn	Værdi	Beskrivelse
k_ECheckFileSignatureInvalidSignature	0
k_ECheckFileSignatureValidSignature	1
k_ECheckFileSignatureFileNotFound	2
k_ECheckFileSignatureNoSignaturesFoundForThisApp	3
k_ECheckFileSignatureNoSignaturesFoundForThisFile	4

EGamepadTextInputLineMode

Styrer antallet af tilladte linjer i gamepad-tekstfeltet i Big Picture

Navn	Værdi	Beskrivelse
k_EGamepadTextInputLineModeSingleLine	0
k_EGamepadTextInputLineModeMultipleLines	1

EGamepadTextInputMode

Inputtilstande for gamepad-tekstfeltet i Big Picture

Navn	Værdi	Beskrivelse
k_EGamepadTextInputModeNormal	0
k_EGamepadTextInputModePassword	1

EFloatingGamepadTextInputMode

Styrer tilstanden for det svævende tastatur

Navn	Værdi	Beskrivelse
k_EFloatingGamepadTextInputModeModeSingleLine	0	Enter lukker for tastaturet
k_EFloatingGamepadTextInputModeModeMultipleLines	1	Brugeren skal selv lukke tastaturet
k_EFloatingGamepadTextInputModeModeEmail	2	Tastaturet vises i en særlig tilstand, der gør det lettere at indtaste e-mailadresser
k_EFloatingGamepadTextInputModeModeNumeric	3	Det numeriske tastatur vises

ESteamAPICallFailure

Resultater med Steam API-kaldefejl returneres af GetAPICallFailureReason.

Navn	Værdi	Beskrivelse
k_ESteamAPICallFailureNone	-1	Ingen fejl.
k_ESteamAPICallFailureSteamGone	0	Den lokale Steam-proces svarer ikke. Den kan være blevet tvunget til at lukke eller er frosset.
k_ESteamAPICallFailureNetworkFailure	1	Netværksforbindelsen til Steam-serverne gik tabt eller var allerede afbrudt. Tilbagekaldet SteamServersDisconnected_t sendes på samme tid, og tilbagekaldet SteamServersConnected_t sendes, når klienten kan kommunikere med Steam-serverne igen.
k_ESteamAPICallFailureInvalidHandle	2	Det sendte handle SteamAPICall_t eksisterer ikke længere.
k_ESteamAPICallFailureMismatchedCallback	3	GetAPICallResult blev kaldt med den forkerte type tilbagekald til dette API-kald.

Konstanter

Det følgende er konstanter, som defineres til brug med ISteamUtils.

Navn	Type	Værdi	Beskrivelse
STEAMUTILS_INTERFACE_VERSION	const char *	"SteamUtils009"