Käyttöliittymä, joka tarjoaa pääsyn erilaisiin apuohjelmien funktioihin.
Jäsenfunktiot
ISteamUtils
-käyttöliittymän jäsenfunktioita kutsutaan globaalilla
SteamUtils()
-aksessorifunktiolla.
BOverlayNeedsPresent
bool BOverlayNeedsPresent();
Tarkistaa, tarvitseeko yhteisönäkymä Present()-funktiota. Vaaditaan vain, jos käytössä on tapahtumakohtaisia renderöintipäivityksiä.
Tätä pyyntöä ei yleensä käytetä, jos pelissäsi on jo taustalla pyörivä kuvasilmukka (tämä pätee useimpiin peleihin). Se lähettää jokaisessa kuvaruudussa pyyntöjä joko D3D Present -ohjelmointirajapintaan tai OGL SwapBuffers -ohjelmointirajapintaan. Jos pelisi virkistää näytön tapahtumakohtaisesti, yhteisönäkymä voi mennä rikki, koska se käyttää Present/SwapBuffers -pyyntöjä sisäisen kuvasilmukan ajamiseen. Yhteisönäkymä saattaa myös tarvita Present()-funktiota ilmoitusten ilmestyessä tai silloin, kun käyttäjä tuo yhteisönäkymän esiin pelin aikana. You can use this API to ask the overlay if it currently need a present in that case, and then you can check for this periodically (roughly 33hz is desirable) and make sure you refresh the screen with Present or SwapBuffers to allow the overlay to do its work.
Paluuarvot: bool
true, jos yhteisönäkymä vaatii näytön päivittämistä − muussa tapauksessa arvo on
false.
CheckFileSignature
SteamAPICall_t CheckFileSignature( const char *szFileName );
Nimi | Tyyppi | Kuvaus |
szFileName | const char * | . |
Vanhentunut.
Paluuarvot: SteamAPICall_t-arvoa käytetään palautetulla
CheckFileSignature_t-arvolla.
GetAPICallFailureReason
ESteamAPICallFailure GetAPICallFailureReason( SteamAPICall_t hSteamAPICall );
Nimi | Tyyppi | Kuvaus |
hSteamAPICall | SteamAPICall_t | Steam API -pyynnön tunnus, jonka virhe tarkistetaan. |
Käytetään pyynnön epäonnistumisen syyn selvittämiseen.
Tätä käytetään lähinnä vianmääritykseen. Epäonnistumisen syyt eivät yleensä ole käyttäjän hallinnassa, eikä niillä useimmiten ole merkitystä. Jatka API-pyynnön lähettämistä, kunnes se onnistuu.
Paluuarvot: ESteamAPICallFailure[type]ESteamAPICallFailure[/type]
Lisätietoja: IsAPICallCompleted,
GetAPICallResultEsimerkki:void CHTMLSurface::OnBrowserReady( HTML_BrowserReady_t *pBrowserReady, bool bIOFailure )
{
if ( bIOFailure ) {
SteamUtils()->GetAPICallFailureReason(tunnus); // tunnus on tallennettava erikseen.
return;
}
}
GetAPICallResult
bool GetAPICallResult( SteamAPICall_t hSteamAPICall, void *pCallback, int cubCallback, int iCallbackExpected, bool *pbFailed );
Nimi | Tyyppi | Kuvaus |
hSteamAPICall | SteamAPICall_t | API-pyynnön tunnus. |
pCallback | void * | Palauttaa takaisinkutsun ennaltamäärättyyn sijaintiin muistissa. |
cubCallback | int | Käytetyn pCallback-arvon koko. |
iCallbackExpected | int | Takaisinkutsun k_iCallback-numero. |
pbFailed | bool * | Palautetaan, jos API-pyyntö epäonnistuu. |
Hakee valmiin API-pyynnön sisällön. Taustajärjestelmälle toimitettu CallResult-yhteenveto.
Tätä ei yleensä kannata käyttää manuaalisesti.
Paluuarvot: bool
true onnistuneen API-pyynnön tultua valmiiksi − muussa tapauksessa arvo on
false.
Jos pyyntö onnistuu, takaisinkutsu kopioituu kohteeseen
pCallback
ja virheet palautuvat kohteeseen
pbFailed
.
Lisätietoja: IsAPICallCompleted,
GetAPICallFailureReasonGetAppID
uint32 GetAppID();
Noutaa nykyisen prosessin sovellustunnuksen.
Paluuarvot: uint32Palauttaa sovellustunnuksen.
GetConnectedUniverse
EUniverse GetConnectedUniverse();
Noutaa universen, johon nykyinen asiakasohjelma yhdistää. (Vain Valven käyttöön.)
Paluuarvot: EUniverse[type]EUniverse[/type]
GetCSERIPPort
bool GetCSERIPPort( uint32 *unIP, uint16 *usPort );
Nimi | Tyyppi | Kuvaus |
unIP | uint32 * | Palauttaa asiakasohjelmaan yhdistäneen laitteen IP-osoitteen. |
usPort | uint16 * | Ilmoittaa portin, johon asiakasohjelma on yhdistetty. |
Gets the IP of the reporting server for Valve - currently only used in Source engine games
Paluuarvot: bool
Antaa arvon
true, jos käyttäjällä on verkkoyhteys, mutta muutoin arvon
false.
GetCurrentBatteryPower
uint8 GetCurrentBatteryPower();
Ilmoittaa tietokoneen akun varaustilan.
Paluuarvot: uint8Akun varaustila välillä [0..100] %. Palauttaa arvon 255, jos käyttäjä käyttää vaihtovirtaa.
GetEnteredGamepadTextInput
bool GetEnteredGamepadTextInput( char *pchText, uint32 cchText );
Nimi | Tyyppi | Kuvaus |
pchText | char * | Ennalta sijoitettu puskuri, johon tekstisyötteen merkkijono kopioidaan. |
cchText | uint32 | pchText -puskurin koko. |
Noutaa peliohjaimen tekstisyötteen televisiotilan peitetasolta.
Tämä pyyntö suoritetaan
GamepadTextInputDismissed_t-takaisinkutsussa ainoastaan silloin, kun
GamepadTextInputDismissed_t.m_bSubmitted
-totuusmuuttujan arvo on true.
Provides the text input as UTF-8.
Paluuarvot: bool
true jos on vastaanotettavaa tekstiä ja
cchText
on saman kokoinen kuin GamepadTextInputDismissed_t.m_unSubmittedText − muussa tapauksessa arvona on
false.
Lisätietoja: ShowGamepadTextInput,
GetEnteredGamepadTextLengthEsimerkki:void OnGamepadTextInputDismissed_t( GamepadTextInputDismissed_t* pCallback )
{
// Käyttäjä peruutti,
if ( !pCallback.m_bSubmitted )
return;
// Saat nolla-arvon ottamalla jonkin ShowGamepadTextInput-kohdassa käytetyn maksimimittaisen syötteen pituuden +1.
const uint32 MAX_INPUT_LENGTH = 64 + 1;
uint32 length = SteamUtils()->GetEnteredGamepadTextLength();
char* szTextInput[MAX_INPUT_LENGTH];
bool success = SteamUtils()->GetEnteredGamepadTextInput( szTextInput, length );
if ( !success )
{
// Luo virheloki. Tämä tapahtuu vain, jos pituus on > MaxInputLength
return;
}
// Näytä päivitetty merkkijono
}
GetEnteredGamepadTextLength
uint32 GetEnteredGamepadTextLength();
Noutaa peliohjaimen tekstisyötteen pituuden televisiotilan peitetasolta.
Tämä pyyntö suoritetaan
GamepadTextInputDismissed_t-takaisinkutsussa ainoastaan, jos
GamepadTextInputDismissed_t.m_bSubmitted
-totuusmuuttujan arvo on true.
Paluuarvot: uint32Lisätietoja: ShowGamepadTextInput,
GetEnteredGamepadTextInputEsimerkki:void OnGamepadTextInputDismissed_t( GamepadTextInputDismissed_t* pCallback )
{
// Käyttäjä peruutti,
if ( !pCallback.m_bSubmitted )
return;
// Saat nolla-arvon ottamalla jonkin ShowGamepadTextInput-kohdassa käytetyn maksimimittaisen syötteen pituuden +1.
const uint32 MAX_INPUT_LENGTH = 64 + 1;
uint32 length = SteamUtils()->GetEnteredGamepadTextLength();
const char* szTextInput[MAX_INPUT_LENGTH];
bool success = SteamUtils()->GetEnteredGamepadTextInput( szTextInput, length );
if ( !success )
{
// Luo virheloki. Tämä tapahtuu vain, jos pituus on > MaxInputLength
return;
}
// Näytä päivitetty merkkijono
}
GetImageRGBA
bool GetImageRGBA( int iImage, uint8 *pubDest, int nDestBufferSize );
Nimi | Tyyppi | Kuvaus |
iImage | int | The handle to the image that will be obtained. |
pubDest | uint8 * | Puskuri, joka täytetään. |
nDestBufferSize | int | pubDest -puskurin koko. |
Noutaa kuvan tavut kuvatunnuksesta.
Prior to calling this you must get the size of the image by calling
GetImageSize so that you can create your buffer with an appropriate size. You can then allocate your buffer with the width and height as: width * height * 4. The image is provided in RGBA format. Tämä pyyntö voi viedä paljon resursseja, koska se muuntaa pakattuja tiedostotyyppejä (JPG, PNG, TGA), eikä tarjoa sisäistä välimuistia palautetulle puskurille. Siitä syystä tätä pyyntöä kannattaa käyttää vain kerran kuvatunnusta kohden ja siirtää tulokset välimuistiin. This function is only used for Steam Avatars and Achievement images and those are not expected to change mid game.
Paluuarvot: bool
true, onnistuneen pyynnön yhteydessä, jos kuvatunnus on kelvollinen ja puskuri on täytetty − muussa tapauksessa arvo on
false.
Lisätietoja: ISteamFriends::GetSmallFriendAvatar,
ISteamFriends::GetMediumFriendAvatar,
ISteamFriends::GetLargeFriendAvatar,
ISteamUserStats::GetAchievementIconEsimerkki:HGAMETEXTURE GetSteamImageAsTexture( int iImage )
{
HGAMETEXTURE hTexture = 0;
// You should first check if you have already cached this image using something like a dictionary/map
// with iImage as the key and then return the texture handle associated with it if it exists.
// If it doesn't exist, continue on, and add the texture to the map before returning at the end of the function.
// If we have to check the size of the image.
uint32 uAvatarWidth, uAvatarHeight;
bool success = SteamUtils()->GetImageSize( iImage, &uAvatarWidth, &uAvatarHeight );
if ( !success ) {
// Log a warning message.
return hTexture;
}
// Get the actual raw RGBA data from Steam and turn it into a texture in our game engine
const int uImageSizeInBytes = uAvatarWidth * uAvatarHeight * 4;
uint8 *pAvatarRGBA = new uint8[uImageSizeInBytes];
success = SteamUtils()->GetImageRGBA( iImage, pAvatarRGBA, uImageSizeInBytes );
if( !success )
{
// Do something to convert the RGBA texture into your internal texture format for displaying.
// hTexture = m_pGameEngine->HCreateTexture( pAvatarRGBA, uAvatarWidth, uAvatarHeight );
// And add the texture to the cache
}
// Don't forget to free the memory!
delete[] pAvatarRGBA;
return hTexture;
}
GetImageSize
bool GetImageSize( int iImage, uint32 *pnWidth, uint32 *pnHeight );
Nimi | Tyyppi | Kuvaus |
iImage | int | The image handle to get the size for. |
pnWidth | uint32 * | Palauttaa kuvan leveyden. |
pnHeight | uint32 * | Palauttaa kuvan pituuden. |
Noutaa Steam-kuvatunnuksen koon.
Tämä pitää suorittaa ennen
GetImageRGBA-pyyntöä, jotta voit luoda oikean kokoisen puskurin käsittelemättömälle kuvadatalle.
Paluuarvot: bool
true onnistuneen pyynnön yhteydessä, jos kuvatunnus on kelvollinen ja koot on täytetty − muussa tapauksessa arvo on
false.
Lisätietoja: ISteamFriends::GetSmallFriendAvatar,
ISteamFriends::GetMediumFriendAvatar,
ISteamFriends::GetLargeFriendAvatar,
ISteamUserStats::GetAchievementIconGetIPCCallCount
uint32 GetIPCCallCount();
Antaa IPC-pyyntöjen määrän tämän funktion edelliseltä käyttökerralta.
Käytetään suorituskyvyn virheenkorjaukseen. Tämän ansiosta tiedät, montako Inter-Process Communication- eli IPC-kutsua peli tekee ruutua kohden.
Jokainen IPC-kutsu tapahtuu vähintäänkin kontekstikytkimen säikeiden välillä, ja toisinaan myös prosessien välillä, joten suorituksen taajuutta kannattaa valvoa.
Paluuarvot: uint32GetIPCountry
const char * GetIPCountry();
Antaa asiakasohjelman käyttämän kaksikirjaimisen maakoodin muodossa ISO 3166-1-alpha-2.
esim. "US" tai "UK".
This is looked up via an IP-to-location database.
Paluuarvot: const char *
GetSecondsSinceAppActive
uint32 GetSecondsSinceAppActive();
Returns the number of seconds since the application was active.
Paluuarvot: uint32GetSecondsSinceComputerActive
uint32 GetSecondsSinceComputerActive();
Returns the number of seconds since the user last moved the mouse.
Paluuarvot: uint32GetServerRealTime
uint32 GetServerRealTime();
Returns the Steam server time in Unix epoch format. (Number of seconds since Jan 1, 1970 UTC)
Paluuarvot: uint32GetSteamUILanguage
const char * GetSteamUILanguage();
Ilmoittaa Steam-asiakasohjelman käyttämän kielen.
You probably want
ISteamApps::GetCurrentGameLanguage instead, this should only be used in very special cases.
Täyden listan kielistä löydät täältä:
Tuetut kielet.
Paluuarvot: const char *
Lisätietoja: ISteamApps::GetCurrentGameLanguage,
ISteamApps::GetAvailableGameLanguagesIsAPICallCompleted
bool IsAPICallCompleted( SteamAPICall_t hSteamAPICall, bool *pbFailed );
Nimi | Tyyppi | Kuvaus |
hSteamAPICall | SteamAPICall_t | API-pyynnön tunnus, joka tarkistetaan. |
pbFailed | bool * | Returns whether the API call has encountered a failure (true) or not (false). |
Checks if an API Call is completed. Antaa taustajärjestelmälle CallResult-yhteenvedon.
Tätä ei yleensä kannata käyttää.
Paluuarvot: bool
true jos API-pyyntö on kelvollinen ja loppuun suoritettu − muussa tapauksessa arvo on
false.
Lisätietoja: GetAPICallResult,
GetAPICallFailureReasonIsOverlayEnabled
bool IsOverlayEnabled();
Tarkistaa, onko
Steamin yhteisönäkymä päällä, ja pystyykö käyttäjä käyttämään sitä.
Yhteisönäkymän käynnistymiseen ja peliin liittämiseen voi mennä muutamia sekunteja. Yhteisönäkymän latautuessa kutsu palauttaa arvon "false" (epätosi).
Paluuarvot: bool
IsSteamChinaLauncher
bool IsSteamChinaLauncher();
Returns whether the current launcher is a Steam China launcher. Voit saada asiakasohjelman toimimaan kuten Steam China -käynnistysohjelma, jos lisäät komentoriviin -dev -steamchina, kun Steam on päällä.
InitFilterText
bool InitFilterText();
Ottaa käyttöön tekstisuodatuksen ja lataa sanakirjat pelin käyttämälle kielelle.
Users can customize the text filter behavior in their
Steam Account preferencesPaluuarvot: bool
true, jos alustaminen onnistuu. Jos suodatus ei ole saatavilla pelin kielelle, arvo on
false. Siinä tapauksessa käytetään
FilterText()-funktiota.
Lisätietoja: FilterTextFilterText
int FilterText( ETextFilteringContext eContext, CSteamID sourceSteamID, const char *pchInputMessage, char *pchOutFilteredText, uint32 nByteSizeOutFilteredText );
Nimi | Tyyppi | Kuvaus |
eContext | ETextFilteringContext | syötetyn merkkijonon sisältötyyppi |
sourceSteamID | CSteamID | syötetyn merkkijonon lähteen Steam ID (esim. pelaajan tai chat-viestin lähettäjän nimi) |
pchInputText | const char* | the input string that should be filtered, which can be ASCII or UTF-8 |
pchOutFilteredText | char* | sijainti, johon ulostulo laitetaan, vaikka suodatusta ei suoritettaisi |
nByteSizeOutFilteredText | uint32 | pchOutFilteredText-tiedoston koko tavuina tulee olla vähintään yhtä iso kuin strlen(pchInputText)+1 |
Suodattaa syötetyn viestin ja siirtää suodatetun tuloksen tiedostoon pchOutFilteredText. Lain määräämät suodatuksen ovat aina käytössä. Muut suodatukset riippuvat kontekstista ja käyttäjän asetuksista.
Paluuarvot: int
Returns the number of characters (not bytes) filtered.
Lisätietoja: InitFilterTextIsSteamInBigPictureMode
bool IsSteamInBigPictureMode();
Tarkistaa, ovatko Steam ja Steamin yhteisönäkymä käytössä televisiotilassa.
Games must be launched through the Steam client to enable the Big Picture overlay.
During development, a game can be added as a non-steam game to the developer's library to test this feature.
Paluuarvot: bool
true if the Big Picture overlay is available; otherwise,
false.
This will always return
false if your app is not the 'game'
application type.
IsSteamRunningInVR
bool IsSteamRunningInVR();
Tarkistaa, onko Steam VR-tilassa.
Paluuarvot: bool
true jos itse Steam on VR-tilassa − muussa tapauksessa arvo on
false.
IsVRHeadsetStreamingEnabled
bool IsVRHeadsetStreamingEnabled();
Checks if the HMD view is being streamed via Steam Remote Play.
Paluuarvot: bool
true jos VR on käytössä ja HMD-näkymää suoratoistetaan − muussa tapauksessa arvo on
false.
Lisätietoja: SetVRHeadsetStreamingEnabledIsSteamRunningOnSteamDeck
bool IsSteamRunningOnSteamDeck();
Tarkistaa, onko Steam käytössä Steam Deck -laitteella.
Paluuarvot: bool
true jos itse Steam pyörii Steam Deck -laiteella − muussa tapauksessa arvo on
false.
SetOverlayNotificationInset
void SetOverlayNotificationInset( int nHorizontalInset, int nVerticalInset );
Nimi | Tyyppi | Kuvaus |
nHorizontalInset | int | Vaakasuora (vasemmalta oikealle) pituus pikseleinä kulmasta alkaen. |
nVerticalInset | int | Pystysuora (ylhäältä alas) pituus pikseleinä kulmasta alkaen. |
Sets the inset of the overlay notification from the corner specified by
SetOverlayNotificationPosition.
Jos koordinaateiksi annetaan (0, 0), sijainti palaa alkuperäiseen kulmaan.
Tämä sijainti on pelikohtainen ja palaa käynnistyksen yhteydessä oletusasetuksiin.
SetOverlayNotificationPosition
void SetOverlayNotificationPosition( ENotificationPosition eNotificationPosition );
Sets which corner the Steam overlay notification popup should display itself in.
You can also set the distance from the specified corner by using
SetOverlayNotificationInset.
Tämä sijainti on pelikohtainen ja palaa käynnistyksen yhteydessä oletusasetuksiin.
SetVRHeadsetStreamingEnabled
void SetVRHeadsetStreamingEnabled( bool bEnabled );
Nimi | Tyyppi | Kuvaus |
bEnabled | bool | Käynnistää (true) tai sammuttaa (false) VR HMD -suoratoiston. |
Valitse, suoratoistetaanko HMD-sisältöä Steam Remote Playssa.
Jos tämä on käytössä, VR-lasien sisältö suoratoistetaan, eikä etäsyötettä sallita. Muussa tapauksessa sovellusikkuna suoratoistetaan ja etäsyöte sallitaan. VR-peleissä tämä on päällä oletusarvoisesti, paitsi jos pelin pidennetyssä appinfo-tiedostossa on "VRHeadsetStreaming" "0".
This is useful for games that have asymmetric multiplayer gameplay.
Lisätietoja: IsVRHeadsetStreamingEnabledSetWarningMessageHook
void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );
Nimi | Tyyppi | Kuvaus |
pFunction | SteamAPIWarningMessageHook_t | Function pointer to the callback function. |
Sets a warning message hook to receive SteamAPI warnings and info messages in a callback function.
The function prototype must match the definition in SteamAPIWarningMessageHook_t. This includes the extern "C" linkage and __cdecl calling convention.
'int nSeverity' kertoo vakavuuden. 0 on viesteille ja 1 on varoituksille. If you are running in through a debugger only warnings will be sent. If you add -debug_steamapi to the command-line then informational messages will also be sent.
'const char * pchDebugText' is the text of the message.
Callbacks will occur directly after the API function is called that generated the warning or message
Arvo NULL poistaa kiinnityksen.
Esimerkki:extern "C" void __cdecl SteamAPIDebugTextHook( int nSeverity, const char *pchDebugText )
{
::OutputDebugString( pchDebugText );
if ( nSeverity >= 1 )
{
// Aseta pysäytyspiste API-virheille
int x = 3;
x = x;
}
}
void EnableWarningMessageHook()
{
SteamUtils()->SetWarningMessageHook( &SteamAPIDebugTextHook );
}
ShowGamepadTextInput
bool ShowGamepadTextInput( EGamepadTextInputMode eInputMode, EGamepadTextInputLineMode eLineInputMode, const char *pchDescription, uint32 unCharMax, const char *pchExistingText );
Nimi | Tyyppi | Kuvaus |
eInputMode | EGamepadTextInputMode | Selects the input mode to use, either Normal or Password (hidden text) |
eLineInputMode | EGamepadTextInputLineMode | Ohjaa sitä, käytetäänkö yhden vai useamman rivin syötettä. |
pchDescription | const char * | Sets the description that should inform the user what the input dialog is for. |
unCharMax | uint32 | Käyttäjän syöttämien merkkien enimmäismäärä. |
pchExistingText | const char * | Sets the preexisting text which the user can edit. |
Käynnistää televisiotilan tekstisyöteikkunan, joka tukee ainoastaan ohjaimen syötettä.
Paluuarvot: bool
true jos televisiotilan yhteisönäkymä on käytössä − muussa tapauksessa arvo on
false.
Lisätietoja: GetEnteredGamepadTextLength,
GetEnteredGamepadTextInputShowFloatingGamepadTextInput
bool ShowFloatingGamepadTextInput( EFloatingGamepadTextInputMode eKeyboardMode, int nTextFieldXPosition, int nTextFieldYPosition, int nTextFieldWidth, int nTextFieldHeight );
Nimi | Tyyppi | Kuvaus |
eKeyboardMode | EFloatingGamepadTextInputMode | Valitsee käytettävän näppäimistötyypin |
nTextFieldXPosition | int | X coordinate of text field which shouldn't be obscured by the floating keyboard |
nTextFieldYPosition | int | Y coordinate of text field which shouldn't be obscured by the floating keyboard |
nTextFieldWidth | int | width of text field which shouldn't be obscured by the floating keyboard |
nTextFieldHeight | int | height of text field which shouldn't be obscured by the floating keyboard |
Avaa näyttönäppäimistön pelisisällön päälle ja lähettää käyttöjärjestelmän merkkisyötteen suoraan peliin.
Tekstikentän sijainti ilmaistaan pikseleinä suhteessa peli-ikkunan alkupisteestä, ja sitä käytetään näyttönäppäimistön sijoittamiseen niin, ettei se ole tekstikentän edessä.
Paluuarvot: bool
true jos näyttönäppäimistö on näkyvissä − muussa tapauksessa arvo on
false.
Lisätietoja: FloatingGamepadTextInputDismissed_tStartVRDashboard
void StartVRDashboard();
Pyytää Steamiä luomaan ja renderöimään OpenVR-työpöydän.
SetGameLauncherMode
void SetGameLauncherMode( bool bLauncherMode);
Nimi | Tyyppi | Kuvaus |
bLauncherMode | bool | Whether a launcher is active or not |
In game launchers that don't have controller support you can call this to have Steam Input translate the controller input into mouse/kb to navigate the launcher
Takaisinkutsut
These are callbacks which can be fired by calling
SteamAPI_RunCallbacks. Many of these will be fired directly in response to the member functions of
ISteamUtils
.
CheckFileSignature_t
CallResult for
CheckFileSignature.
Associated Functions: CheckFileSignatureGamepadTextInputDismissed_t
Called when the big picture gamepad text input has been closed.
Nimi | Tyyppi | Kuvaus |
m_bSubmitted | bool | Arvo on true, jos käyttäjä syötti ja vastaanotti tekstiä (pyynnöllä GetEnteredGamepadTextInput vastaanotetaan tekstiä). Jos syöte peruttiin, palautettu arvo on false. |
m_unSubmittedText | uint32 | Sisältää lähetetyn tekstin pituuden tavuina. |
FloatingGamepadTextInputDismissed_t
Called when the floating keyboard invoked from
ShowFloatingGamepadTextInput has been closed.
IPCountry_t
Called when the country of the user changed. The country should be updated with
GetIPCountry.
This callback has no fields.
LowBatteryPower_t
Called when running on a laptop and less than 10 minutes of battery is left, and then fires then every minute afterwards.
Nimi | Tyyppi | Kuvaus |
m_nMinutesBatteryLeft | uint8 | Arvioitu akun kesto minuutteina. |
SteamAPICallCompleted_t
Called when a SteamAPICall_t has completed (or failed)
Nimi | Tyyppi | Kuvaus |
m_hAsyncCall | SteamAPICall_t | The handle of the Steam API Call that completed. |
m_iCallback | int | Tämä on k_iCallback-vakio, jolla tunnistetaan valmis takaisinkutsu. |
m_cubParam | uint32 | Valmiin takaisinkutsun koko tavuina. |
AppResumingFromSuspend_t
Sent after the device returns from sleep/suspend mode.
This callback has no fields.
SteamShutdown_t
Called when Steam wants to shutdown.
This callback has no fields.
Luetellut tyypit
These are enums which are defined for use with ISteamUtils.
ECheckFileSignature
The result of a call to
CheckFileSignature Nimi | Arvo | Kuvaus |
k_ECheckFileSignatureInvalidSignature | 0 | |
k_ECheckFileSignatureValidSignature | 1 | |
k_ECheckFileSignatureFileNotFound | 2 | |
k_ECheckFileSignatureNoSignaturesFoundForThisApp | 3 | |
k_ECheckFileSignatureNoSignaturesFoundForThisFile | 4 | |
EGamepadTextInputLineMode
Controls number of allowed lines for the Big Picture gamepad text entry
Nimi | Arvo | Kuvaus |
k_EGamepadTextInputLineModeSingleLine | 0 | |
k_EGamepadTextInputLineModeMultipleLines | 1 | |
EGamepadTextInputMode
Input modes for the Big Picture gamepad text entry
Nimi | Arvo | Kuvaus |
k_EGamepadTextInputModeNormal | 0 | |
k_EGamepadTextInputModePassword | 1 | |
EFloatingGamepadTextInputMode
Controls the mode for the floating keyboard
Nimi | Arvo | Kuvaus |
k_EFloatingGamepadTextInputModeModeSingleLine | 0 | Enter-näppäin sulkee näppäimistön |
k_EFloatingGamepadTextInputModeModeMultipleLines | 1 | Käyttäjän on tarkoituksella suljettava näppäimistö |
k_EFloatingGamepadTextInputModeModeEmail | 2 | Keyboard is displayed in a special mode that makes it easier to enter emails |
k_EFloatingGamepadTextInputModeModeNumeric | 3 | Numeronäppäimet ovat näkyvillä |
ESteamAPICallFailure
Steam API call failure results returned by
GetAPICallFailureReason.
Nimi | Arvo | Kuvaus |
k_ESteamAPICallFailureNone | -1 | Ei virheitä. |
k_ESteamAPICallFailureSteamGone | 0 | Paikallinen Steam-prosessi on lakkanut toimimasta. Se on ehkä pakotettu sulkemaan tai jumittunut. |
k_ESteamAPICallFailureNetworkFailure | 1 | Internet-yhteys Steam-palvelimiin on katkennut tai se oli jo valmiiksi poikki. SteamServersDisconnected_t-takaisinkutsu lähetetään samaan aikaan, ja SteamServersConnected_t-takaisinkutsu lähetetään sitten, kun asiakasohjelma saa taas yhteyden Steam-palvelimiin. |
k_ESteamAPICallFailureInvalidHandle | 2 | The SteamAPICall_t handle passed in no longer exists. |
k_ESteamAPICallFailureMismatchedCallback | 3 | GetAPICallResult-pyyntö lähetettiin väärällä takaisinkutsutyypillä tälle API-pyynnölle. |
Vakiot
These are constants which are defined for use with ISteamUtils.
Nimi | Tyyppi | Arvo | Kuvaus |
STEAMUTILS_INTERFACE_VERSION | const char * | "SteamUtils009" | |