|
GOG GALAXY SDK Documentation
|
Modules | |
| Peer | |
| GameServer | |
Classes | |
| class | IError |
| Base interface for exceptions. More... | |
| class | IUnauthorizedAccessError |
| The exception thrown when calling Galaxy interfaces while the user is not signed in and thus not authorized for any interaction. More... | |
| class | IInvalidArgumentError |
| The exception thrown to report that a method was called with an invalid argument. More... | |
| class | IInvalidStateError |
| The exception thrown to report that a method was called while the callee is in an invalid state, i.e. More... | |
| class | IRuntimeError |
| The exception thrown to report errors that can only be detected during runtime. More... | |
| struct | GalaxyAllocator |
| Custom memory allocator for GOG Galaxy SDK. More... | |
| class | GalaxyID |
| Represents the ID of an entity used by Galaxy Peer. More... | |
| class | IGalaxyThread |
| The interface representing a thread object. More... | |
| class | IGalaxyThreadFactory |
| Custom thread spawner for the Galaxy SDK. More... | |
| class | IIsDlcOwnedListener |
| Listener for the result of IsDLCOwned method. More... | |
| class | IApps |
| The interface for managing application activities. More... | |
| class | IChatRoomWithUserRetrieveListener |
| Listener for the event of retrieving a chat room with a specified user. More... | |
| class | IChatRoomMessageSendListener |
| Listener for the event of sending a chat room message. More... | |
| class | IChatRoomMessagesListener |
| Listener for the event of receiving chat room messages. More... | |
| class | IChatRoomMessagesRetrieveListener |
| Listener for the event of retrieving chat room messages in a specified chat room. More... | |
| class | IChat |
| The interface for chat communication with other Galaxy Users. More... | |
| class | ICloudStorageGetFileListListener |
| Listener for the event of downloading a list of files stored in cloud storage. More... | |
| class | ICloudStorageGetFileListener |
| Listener for the event of downloading a file stored in cloud storage. More... | |
| class | ICloudStoragePutFileListener |
| Listener for the event of uploading a local file to the cloud storage. More... | |
| class | ICloudStorageDeleteFileListener |
| Listener for the event of deleting a file stored in cloud storage. More... | |
| class | ICloudStorage |
| The interface for cross-platform CloudStorage file management. More... | |
| class | IConnectionOpenListener |
| Listener for the events related to opening a connection. More... | |
| class | IConnectionCloseListener |
| Listener for the event of closing a connection. More... | |
| class | IConnectionDataListener |
| Listener for the event of receiving data over the connection. More... | |
| class | ICustomNetworking |
| The interface for communicating with a custom endpoint. More... | |
| class | IPersonaDataChangedListener |
| Listener for the event of changing persona data. More... | |
| class | IUserInformationRetrieveListener |
| Listener for the event of retrieving requested user's information. More... | |
| class | IFriendListListener |
| Listener for the event of retrieving requested list of friends. More... | |
| class | IFriendInvitationSendListener |
| Listener for the event of sending a friend invitation. More... | |
| class | IFriendInvitationListRetrieveListener |
| Listener for the event of retrieving requested list of incoming friend invitations. More... | |
| class | ISentFriendInvitationListRetrieveListener |
| Listener for the event of retrieving requested list of outgoing friend invitations. More... | |
| class | IFriendInvitationListener |
| Listener for the event of receiving a friend invitation. More... | |
| class | IFriendInvitationRespondToListener |
| Listener for the event of responding to a friend invitation. More... | |
| class | IFriendAddListener |
| Listener for the event of a user being added to the friend list. More... | |
| class | IFriendDeleteListener |
| Listener for the event of removing a user from the friend list. More... | |
| class | IRichPresenceChangeListener |
| Listener for the event of rich presence modification. More... | |
| class | IRichPresenceListener |
| Listener for the event of any user rich presence update. More... | |
| class | IRichPresenceRetrieveListener |
| Listener for the event of retrieving requested user's rich presence. More... | |
| class | IGameJoinRequestedListener |
| Event of requesting a game join by user. More... | |
| class | IGameInvitationReceivedListener |
| Event of receiving a game invitation. More... | |
| class | ISendInvitationListener |
| Listener for the event of sending an invitation without using the overlay. More... | |
| class | IUserFindListener |
| Listener for the event of searching a user. More... | |
| class | IFriends |
| The interface for managing social info and activities. More... | |
| class | IGalaxyListener |
| The interface that is implemented by all specific callback listeners. More... | |
| class | GalaxyTypeAwareListener< type > |
| The class that is inherited by all specific callback listeners and provides a static method that returns the type of the specific listener. More... | |
| class | IListenerRegistrar |
| The class that enables and disables global registration of the instances of specific listeners. More... | |
| class | SelfRegisteringListener< _TypeAwareListener, _Registrar > |
| The class that is inherited by the self-registering versions of all specific callback listeners. More... | |
| class | ILogger |
| The interface for logging. More... | |
| class | ILobbyListListener |
| Listener for the event of receiving a list of lobbies. More... | |
| class | ILobbyCreatedListener |
| Listener for the event of creating a lobby. More... | |
| class | ILobbyEnteredListener |
| Listener for the event of entering a lobby. More... | |
| class | ILobbyLeftListener |
| Listener for the event of leaving a lobby. More... | |
| class | ILobbyDataListener |
| Listener for the event of receiving an updated version of lobby data. More... | |
| class | ILobbyDataUpdateListener |
| Listener for the event of updating lobby data. More... | |
| class | ILobbyMemberDataUpdateListener |
| Listener for the event of updating lobby member data. More... | |
| class | ILobbyDataRetrieveListener |
| Listener for the event of retrieving lobby data. More... | |
| class | ILobbyMemberStateListener |
| Listener for the event of a change of the state of a lobby member. More... | |
| class | ILobbyOwnerChangeListener |
| Listener for the event of changing the owner of a lobby. More... | |
| class | ILobbyMessageListener |
| Listener for the event of receiving a lobby message. More... | |
| class | IMatchmaking |
| The interface for managing game lobbies. More... | |
| class | INetworkingListener |
| Listener for the events related to packets that come to the client. More... | |
| class | INatTypeDetectionListener |
| Listener for the events related to NAT type detection. More... | |
| class | INetworking |
| The interface for communicating with other Galaxy Peers. More... | |
| struct | InitOptions |
| The group of options used for Init configuration. More... | |
| class | IUserStatsAndAchievementsRetrieveListener |
| Listener for the event of retrieving statistics and achievements of a specified user, possibly our own. More... | |
| class | IStatsAndAchievementsStoreListener |
| Listener for the event of storing own statistics and achievements. More... | |
| class | IAchievementChangeListener |
| Listener for the event of changing an achievement. More... | |
| class | ILeaderboardsRetrieveListener |
| Listener for the event of retrieving definitions of leaderboards. More... | |
| class | ILeaderboardEntriesRetrieveListener |
| Listener for the event of retrieving requested entries of a leaderboard. More... | |
| class | ILeaderboardScoreUpdateListener |
| Listener for the event of updating score in a leaderboard. More... | |
| class | ILeaderboardRetrieveListener |
| Listener for the event of retrieving definition of a leaderboard. More... | |
| class | IUserTimePlayedRetrieveListener |
| Listener for the event of retrieving user time played. More... | |
| class | IStats |
| The interface for managing statistics, achievements and leaderboards. More... | |
| class | IFileShareListener |
| Listener for the event of sharing a file. More... | |
| class | ISharedFileDownloadListener |
| Listener for the event of downloading a shared file. More... | |
| class | IStorage |
| The interface for managing of cloud storage files. More... | |
| class | ITelemetryEventSendListener |
| Listener for the event of sending a telemetry event. More... | |
| class | ITelemetry |
| The interface for handling telemetry. More... | |
| class | IAuthListener |
| Listener for the events related to user authentication. More... | |
| class | IOtherSessionStartListener |
| Listener for the events related to starting of other sessions. More... | |
| class | IOperationalStateChangeListener |
| Listener for the event of a change of the operational state. More... | |
| class | IUserDataListener |
| Listener for the events related to user data changes of current user only. More... | |
| class | ISpecificUserDataListener |
| Listener for the events related to user data changes. More... | |
| class | IEncryptedAppTicketListener |
| Listener for the event of retrieving a requested Encrypted App Ticket. More... | |
| class | IAccessTokenListener |
| Listener for the event of a change of current access token. More... | |
| class | IPlayFabCreateOpenIDConnectionListener |
| Listener for the event of creating an OpenID connection. More... | |
| class | IPlayFabLoginWithOpenIDConnectListener |
| Listener for the event of logging with an OpenID Connect. More... | |
| class | IUser |
| The interface for handling the user account. More... | |
| class | IOverlayVisibilityChangeListener |
| Listener for the event of changing overlay visibility. More... | |
| class | IOverlayInitializationStateChangeListener |
| Listener for the event of changing overlay state. More... | |
| class | INotificationListener |
| Listener for the event of receiving a notification. More... | |
| class | IGogServicesConnectionStateListener |
| Listener for the event of GOG services connection change. More... | |
| class | IUtils |
| The interface for managing images. More... | |
| struct | ShutdownOptions |
| The group of options used for Shutdown options. More... | |
Functions | |
| GALAXY_DLL_EXPORT const IError *GALAXY_CALLTYPE | GetError () |
| Retrieves error connected with the last API call on the local thread. More... | |
| typedef void(* GalaxyFree) (void *ptr) |
Free function.
| [in] | ptr | Pointer to memory block requested to be freed. |
| typedef void*(* GalaxyMalloc) (uint32_t size, const char *typeName) |
Allocate function.
| [in] | size | Requested size of allocation. |
| [in] | typeName | String which identifies the type of allocation. |
| typedef void*(* GalaxyRealloc) (void *ptr, uint32_t newSize, const char *typeName) |
Reallocate function.
| [in] | ptr | Pointer to the memory block to be reallocated. |
| [in] | newSize | New, requested size of allocation. |
| [in] | typeName | String which identifies the type of allocation. |
| enum AvatarType |
| enum ChatMessageType |
| enum ConnectionType |
State of connection to the GOG services.
The display type of a leaderboard.
| enum ListenerType |
Listener type.
Used when registering or unregistering instances of listeners.
Specific listener interfaces are type-aware, i.e. they provide a convenience method that returns their type.
| Enumerator | |
|---|---|
| LISTENER_TYPE_BEGIN | Used for iterating over listener types. |
| LOBBY_LIST | Used by ILobbyListListener. |
| LOBBY_CREATED | Used by ILobbyCreatedListener. |
| LOBBY_ENTERED | Used by ILobbyEnteredListener. |
| LOBBY_LEFT | Used by ILobbyLeftListener. |
| LOBBY_DATA | Used by ILobbyDataListener. |
| LOBBY_MEMBER_STATE | Used by ILobbyMemberStateListener. |
| LOBBY_OWNER_CHANGE | Used by ILobbyOwnerChangeListener. |
| AUTH | Used by IAuthListener. |
| LOBBY_MESSAGE | Used by ILobbyMessageListener. |
| NETWORKING | Used by INetworkingListener. |
| USER_DATA | Used by IUserDataListener. |
| USER_STATS_AND_ACHIEVEMENTS_RETRIEVE | |
| STATS_AND_ACHIEVEMENTS_STORE | Used by IStatsAndAchievementsStoreListener. |
| ACHIEVEMENT_CHANGE | Used by IAchievementChangeListener. |
| LEADERBOARDS_RETRIEVE | Used by ILeaderboardsRetrieveListener. |
| LEADERBOARD_ENTRIES_RETRIEVE | Used by ILeaderboardEntriesRetrieveListener. |
| LEADERBOARD_SCORE_UPDATE_LISTENER | Used by ILeaderboardScoreUpdateListener. |
| PERSONA_DATA_CHANGED | Used by IPersonaDataChangedListener. |
| RICH_PRESENCE_CHANGE_LISTENER | Used by IRichPresenceChangeListener. |
| GAME_JOIN_REQUESTED_LISTENER | Used by IGameJoinRequested. |
| OPERATIONAL_STATE_CHANGE | Used by IOperationalStateChangeListener. |
| FRIEND_LIST_RETRIEVE | Used by IFriendListListener. |
| ENCRYPTED_APP_TICKET_RETRIEVE | Used by IEncryptedAppTicketListener. |
| ACCESS_TOKEN_CHANGE | Used by IAccessTokenListener. |
| LEADERBOARD_RETRIEVE | Used by ILeaderboardRetrieveListener. |
| SPECIFIC_USER_DATA | Used by ISpecificUserDataListener. |
| INVITATION_SEND | Used by ISendInvitationListener. |
| RICH_PRESENCE_LISTENER | Used by IRichPresenceListener. |
| GAME_INVITATION_RECEIVED_LISTENER | Used by IGameInvitationReceivedListener. |
| NOTIFICATION_LISTENER | Used by INotificationListener. |
| LOBBY_DATA_RETRIEVE | Used by ILobbyDataRetrieveListener. |
| USER_TIME_PLAYED_RETRIEVE | Used by IUserTimePlayedRetrieveListener. |
| OTHER_SESSION_START | Used by IOtherSessionStartListener. |
| FILE_SHARE | Used by IFileShareListener. |
| SHARED_FILE_DOWNLOAD | Used by ISharedFileDownloadListener. |
| CUSTOM_NETWORKING_CONNECTION_OPEN | Used by IConnectionOpenListener. |
| CUSTOM_NETWORKING_CONNECTION_CLOSE | Used by IConnectionCloseListener. |
| CUSTOM_NETWORKING_CONNECTION_DATA | Used by IConnectionDataListener. |
| OVERLAY_INITIALIZATION_STATE_CHANGE | |
| OVERLAY_VISIBILITY_CHANGE | Used by IOverlayVisibilityChangeListener. |
| CHAT_ROOM_WITH_USER_RETRIEVE_LISTENER | Used by IChatRoomWithUserRetrieveListener. |
| CHAT_ROOM_MESSAGE_SEND_LISTENER | Used by IChatRoomMessageSendListener. |
| CHAT_ROOM_MESSAGES_LISTENER | Used by IChatRoomMessagesListener. |
| FRIEND_INVITATION_SEND_LISTENER | Used by IFriendInvitationSendListener. |
| FRIEND_INVITATION_LIST_RETRIEVE_LISTENER | |
| FRIEND_INVITATION_LISTENER | Used by IFriendInvitationListener. |
| FRIEND_INVITATION_RESPOND_TO_LISTENER | Used by IFriendInvitationRespondToListener. |
| FRIEND_ADD_LISTENER | Used by IFriendAddListener. |
| FRIEND_DELETE_LISTENER | Used by IFriendDeleteListener. |
| CHAT_ROOM_MESSAGES_RETRIEVE_LISTENER | Used by IChatRoomMessagesRetrieveListener. |
| USER_FIND_LISTENER | Used by IUserFindListener. |
| NAT_TYPE_DETECTION | Used by INatTypeDetectionListener. |
| SENT_FRIEND_INVITATION_LIST_RETRIEVE_LISTENER | |
| LOBBY_MEMBER_DATA_UPDATE_LISTENER | < Used by ILobbyDataUpdateListener. |
| USER_INFORMATION_RETRIEVE_LISTENER | < Used by ILobbyDataUpdateListener. Used by IUserInformationRetrieveListener. |
| RICH_PRESENCE_RETRIEVE_LISTENER | Used by IRichPresenceRetrieveListener. |
| GOG_SERVICES_CONNECTION_STATE_LISTENER | Used by IGogServicesConnectionStateListener. |
| TELEMETRY_EVENT_SEND_LISTENER | Used by ITelemetryEventSendListener. |
| CLOUD_STORAGE_GET_FILE_LIST | Used by ICloudStorageGetFileListListener. |
| CLOUD_STORAGE_GET_FILE | Used by ICloudStorageGetFileListener. |
| CLOUD_STORAGE_PUT_FILE | Used by ICloudStoragePutFileListener. |
| CLOUD_STORAGE_DELETE_FILE | Used by ICloudStorageDeleteFileListener. |
| IS_DLC_OWNED | Used for IIsDlcOwnedListener. |
| PLAYFAB_CREATE_OPENID_CONNECTION | |
| PLAYFAB_LOGIN_WITH_OPENID_CONNECT | |
| LISTENER_TYPE_END | Used for iterating over listener types. |
| enum LobbyComparisonType |
Comparison type.
Used for specifying filters that are supposed to be invoked to validate lobby properties when requesting for a list of matching lobbies.
| enum LobbyCreateResult |
| enum LobbyEnterResult |
Lobby entering result.
| enum LobbyListResult |
Change of the state of a lobby member.
Used in notifications.
| enum LobbyTopologyType |
Lobby topology type.
Used for specifying topology of user connections in lobby.
| enum LobbyType |
Lobby type.
Used for specifying visibility of a lobby and protecting it.
| enum NatType |
NAT types.
| enum OverlayState |
State of the overlay.
| enum P2PSendType |
Send type used when calling INetworking::SendP2PPacket() in order to specify desired reliability of the data transfer for each packet that is being sent.
| Enumerator | |
|---|---|
| P2P_SEND_UNRELIABLE | UDP-like packet transfer. The packet will be sent during the next call to ProcessData(). |
| P2P_SEND_RELIABLE | TCP-like packet transfer. The packet will be sent during the next call to ProcessData(). |
| P2P_SEND_UNRELIABLE_IMMEDIATE | UDP-like packet transfer. The packet will be sent instantly. |
| P2P_SEND_RELIABLE_IMMEDIATE | TCP-like packet transfer. The packet will be sent instantly. |
| enum PersonaState |
| enum SavegameType |
The type of savegame.
| GALAXY_DLL_EXPORT const IError* GALAXY_CALLTYPE galaxy::api::GetError | ( | ) |
Retrieves error connected with the last API call on the local thread.