Common Types

Simple types


        struct AccountID

Steamworks AccountID_t

Declaration

Swift

public struct AccountID: Hashable, Sendable

extension AccountID: ExpressibleByIntegerLiteral


        struct AppID

Steamworks AppId_t

Declaration

Swift

public struct AppID: Hashable, Sendable

extension AppID: ExpressibleByIntegerLiteral


        struct DepotID

Steamworks DepotId_t

Declaration

Swift

public struct DepotID: Hashable, Sendable

extension DepotID: ExpressibleByIntegerLiteral


        struct HAuthTicket

Steamworks HAuthTicket

Declaration

Swift

public struct HAuthTicket: Hashable, Sendable

extension HAuthTicket: ExpressibleByIntegerLiteral


        struct HSteamPipe

Steamworks HSteamPipe

Declaration

Swift

public struct HSteamPipe: Hashable, Sendable

extension HSteamPipe: ExpressibleByIntegerLiteral


        struct HSteamUser

Steamworks HSteamUser

Declaration

Swift

public struct HSteamUser: Hashable, Sendable

extension HSteamUser: ExpressibleByIntegerLiteral


        struct PartyBeaconID

Steamworks PartyBeaconID_t

Declaration

Swift

public struct PartyBeaconID: Hashable, Sendable

extension PartyBeaconID: ExpressibleByIntegerLiteral


        struct RTime32

Steamworks RTime32

Declaration

Swift

public struct RTime32: Hashable, Sendable

extension RTime32: ExpressibleByIntegerLiteral


        struct SteamAPICall

Steamworks SteamAPICall_t

Declaration

Swift

public struct SteamAPICall: Hashable, Sendable

extension SteamAPICall: ExpressibleByIntegerLiteral


        typealias SteamAPIWarningMessageHook

Declaration

Swift

public typealias SteamAPIWarningMessageHook = (
    (Int32, UnsafePointer<CChar>?) -> Void
)?


        struct SteamErrMsg

Steamworks SteamErrMsg

Declaration

Swift

public struct SteamErrMsg: Hashable, Sendable


        typealias SteamUnsafeMutablePointer

A SendableSendable wrapper of UnsafeMutablePointer.

Declaration

Swift

public typealias SteamUnsafeMutablePointer<T> = SteamUncheckedSendable<
    UnsafeMutablePointer<T>
>


        typealias SteamUnsafeMutableRawPointer

A SendableSendable wrapper of UnsafeMutableRawPointer.

Declaration

Swift

public typealias SteamUnsafeMutableRawPointer = SteamUncheckedSendable<
    UnsafeMutableRawPointer
>


        typealias SteamUnsafeRawPointer

A SendableSendable wrapper of UnsafeRawPointer.

Declaration

Swift

public typealias SteamUnsafeRawPointer = SteamUncheckedSendable<
    UnsafeRawPointer
>

Enumerations and Option Sets


        enum AccountType

Steamworks EAccountType

Declaration

Swift

public enum AccountType: CUnsignedInt, Sendable


        enum AuthSessionResponse

Steamworks EAuthSessionResponse

Declaration

Swift

public enum AuthSessionResponse: CUnsignedInt, Sendable


        enum BeginAuthSessionResult

Steamworks EBeginAuthSessionResult

Declaration

Swift

public enum BeginAuthSessionResult: CUnsignedInt, Sendable


        struct BetaBranchFlags

Steamworks EBetaBranchFlags

Declaration

Swift

public struct BetaBranchFlags: OptionSet, Sendable


        enum BroadcastUploadResult

Steamworks EBroadcastUploadResult

Declaration

Swift

public enum BroadcastUploadResult: CUnsignedInt, Sendable


        enum ChatEntryType

Steamworks EChatEntryType

Declaration

Swift

public enum ChatEntryType: CUnsignedInt, Sendable


        enum ChatRoomEnterResponse

Steamworks EChatRoomEnterResponse

Declaration

Swift

public enum ChatRoomEnterResponse: CUnsignedInt, Sendable


        struct ChatSteamIDInstanceFlags

Steamworks EChatSteamIDInstanceFlags

Declaration

Swift

public struct ChatSteamIDInstanceFlags: OptionSet, Sendable


        enum DenyReason

Steamworks EDenyReason

Declaration

Swift

public enum DenyReason: CUnsignedInt, Sendable


        enum DurationControlNotification

Steamworks EDurationControlNotification

Declaration

Swift

public enum DurationControlNotification: CUnsignedInt, Sendable


        enum DurationControlOnlineState

Steamworks EDurationControlOnlineState

Declaration

Swift

public enum DurationControlOnlineState: CUnsignedInt, Sendable


        enum DurationControlProgress

Steamworks EDurationControlProgress

Declaration

Swift

public enum DurationControlProgress: CUnsignedInt, Sendable


        enum GameSearchErrorCode

Steamworks EGameSearchErrorCode_t

Declaration

Swift

public enum GameSearchErrorCode: CUnsignedInt, Sendable


        struct MarketNotAllowedReasonFlags

Steamworks EMarketNotAllowedReasonFlags

Declaration

Swift

public struct MarketNotAllowedReasonFlags: OptionSet, Sendable


        enum NotificationPosition

Steamworks ENotificationPosition

Declaration

Swift

public enum NotificationPosition: CInt, Sendable


        enum PlayerResult

Steamworks EPlayerResult_t

Declaration

Swift

public enum PlayerResult: CUnsignedInt, Sendable


        enum Result

Steamworks EResult

Declaration

Swift

public enum Result: CUnsignedInt, Sendable


        enum ServerMode

Steamworks EServerMode

Declaration

Swift

public enum ServerMode: CUnsignedInt, Sendable


        enum SteamAPIInitResult

Steamworks ESteamAPIInitResult

Declaration

Swift

public enum SteamAPIInitResult: CUnsignedInt, Sendable


        enum SteamIPType

Steamworks ESteamIPType

Declaration

Swift

public enum SteamIPType: CUnsignedInt, Sendable


        enum SteamIPv6ConnectivityProtocol

Steamworks ESteamIPv6ConnectivityProtocol

Declaration

Swift

public enum SteamIPv6ConnectivityProtocol: CUnsignedInt, Sendable


        enum SteamIPv6ConnectivityState

Steamworks ESteamIPv6ConnectivityState

Declaration

Swift

public enum SteamIPv6ConnectivityState: CUnsignedInt, Sendable


        enum Universe

Steamworks EUniverse

Declaration

Swift

public enum Universe: CUnsignedInt, Sendable


        enum UserHasLicenseForAppResult

Steamworks EUserHasLicenseForAppResult

Declaration

Swift

public enum UserHasLicenseForAppResult: CUnsignedInt, Sendable


        enum VoiceResult

Steamworks EVoiceResult

Declaration

Swift

public enum VoiceResult: CUnsignedInt, Sendable

Structures


        struct GameID

Steamworks CGameID - encapsulates an appID/modID pair

Declaration

Swift

public struct GameID

extension GameID: Hashable, Comparable, CustomStringConvertible, Sendable


        struct SteamID

The globally unique identifier for all Steam accounts, Steam groups, lobbies, and chat rooms.

Steamworks CSteamID. Methods and interface style to follow Steamworks, see docs there.

Declaration

Swift

public struct SteamID

extension SteamID: Hashable, Comparable, CustomStringConvertible, Sendable


        struct SteamIPAddress

Steamworks SteamIPAddress_t

Declaration

Swift

public struct SteamIPAddress

extension SteamIPAddress: Sendable, Hashable


        struct SteamUncheckedSendable

An unsafe SendableSendable wrapper.

This is used to wrap pointers that the Steam API uses in a potentially-sendable context. Typically these pointers are read-only, whether or not the Steam API has marked them const, so there is no real risk to them, but the Steam API client code is responsible for serializing any write action that is required.

Declaration

Swift

public struct SteamUncheckedSendable<Base>: Sendable

extension SteamUncheckedSendable: Equatable where Base: Equatable

extension SteamUncheckedSendable: Hashable where Base: Hashable

Topics

Simple types

struct AccountID

Declaration

struct AppID

Declaration

struct DepotID

Declaration

struct HAuthTicket

Declaration

struct HSteamPipe

Declaration

struct HSteamUser

Declaration

struct PartyBeaconID

Declaration

struct RTime32

Declaration

struct SteamAPICall

Declaration

typealias SteamAPIWarningMessageHook

Declaration

struct SteamErrMsg

Declaration

typealias SteamUnsafeMutablePointer

Declaration

typealias SteamUnsafeMutableRawPointer

Declaration

typealias SteamUnsafeRawPointer

Declaration

Enumerations and Option Sets

enum AccountType

Declaration

enum AuthSessionResponse

Declaration

enum BeginAuthSessionResult

Declaration

struct BetaBranchFlags

Declaration

enum BroadcastUploadResult

Declaration

enum ChatEntryType

Declaration

enum ChatRoomEnterResponse

Declaration

struct ChatSteamIDInstanceFlags

Declaration

enum DenyReason

Declaration

enum DurationControlNotification

Declaration

enum DurationControlOnlineState

Declaration

enum DurationControlProgress

Declaration

enum GameSearchErrorCode

Declaration

struct MarketNotAllowedReasonFlags

Declaration

enum NotificationPosition

Declaration

enum PlayerResult

Declaration

enum Result

Declaration

enum ServerMode

Declaration

enum SteamAPIInitResult

Declaration

enum SteamIPType

Declaration

enum SteamIPv6ConnectivityProtocol

Declaration

enum SteamIPv6ConnectivityState

Declaration

enum Universe

Declaration

enum UserHasLicenseForAppResult

Declaration

enum VoiceResult