SteamRemotePlay

Swift
public struct SteamRemotePlay: Sendable

Steamworks ISteamRemotePlay

Access via remotePlay.


Topics

func enableRemotePlayTogetherDirectInput() -> Bool

Steamworks ISteamRemotePlay::BEnableRemotePlayTogetherDirectInput()

Declaration
Swift
public func enableRemotePlayTogetherDirectInput() -> Bool

func getSessionClientResolution(sessionID: RemotePlaySessionID) -> (rc: Bool, resolutionX: Int, resolutionY: Int)

Steamworks ISteamRemotePlay::BGetSessionClientResolution()

Declaration
Swift
public func getSessionClientResolution(sessionID: RemotePlaySessionID) -> (
    rc: Bool, resolutionX: Int, resolutionY: Int
)

func sendRemotePlayTogetherInvite(friend: SteamID) -> Bool

Steamworks ISteamRemotePlay::BSendRemotePlayTogetherInvite()

Declaration
Swift
public func sendRemotePlayTogetherInvite(friend: SteamID) -> Bool

func createMouseCursor(width: Int, height: Int, hotX: Int, hotY: Int, bgra: UnsafeRawPointer, pitch: Int) -> RemotePlayCursorID

Steamworks ISteamRemotePlay::CreateMouseCursor()

Declaration
Swift
public func createMouseCursor(
    width: Int, height: Int, hotX: Int, hotY: Int, bgra: UnsafeRawPointer,
    pitch: Int = 0
) -> RemotePlayCursorID

func disableRemotePlayTogetherDirectInput()

Steamworks ISteamRemotePlay::DisableRemotePlayTogetherDirectInput()

Declaration
Swift
public func disableRemotePlayTogetherDirectInput()

func getInput(returnInput: Bool, maxEvents: Int) -> (rc: Int, input: [RemotePlayInput])

Steamworks ISteamRemotePlay::GetInput()

Declaration
Swift
public func getInput(returnInput: Bool = true, maxEvents: Int) -> (
    rc: Int, input: [RemotePlayInput]
)

func getSessionClientFormFactor(sessionID: RemotePlaySessionID) -> SteamDeviceFormFactor

Steamworks ISteamRemotePlay::GetSessionClientFormFactor()

Declaration
Swift
public func getSessionClientFormFactor(sessionID: RemotePlaySessionID)
    -> SteamDeviceFormFactor

func getSessionClientName(sessionID: RemotePlaySessionID) -> String?

Steamworks ISteamRemotePlay::GetSessionClientName()

Declaration
Swift
public func getSessionClientName(sessionID: RemotePlaySessionID) -> String?

func getSessionCount() -> Int

Steamworks ISteamRemotePlay::GetSessionCount()

Declaration
Swift
public func getSessionCount() -> Int

func getSessionID(sessionIndex: Int) -> RemotePlaySessionID

Steamworks ISteamRemotePlay::GetSessionID()

Declaration
Swift
public func getSessionID(sessionIndex: Int) -> RemotePlaySessionID

func getSessionSteamID(sessionID: RemotePlaySessionID) -> SteamID

Steamworks ISteamRemotePlay::GetSessionSteamID()

Declaration
Swift
public func getSessionSteamID(sessionID: RemotePlaySessionID) -> SteamID

func setMouseCursor(sessionID: RemotePlaySessionID, cursorID: RemotePlayCursorID)

Steamworks ISteamRemotePlay::SetMouseCursor()

Declaration
Swift
public func setMouseCursor(
    sessionID: RemotePlaySessionID, cursorID: RemotePlayCursorID)

func setMousePosition(sessionID: RemotePlaySessionID, normalizedX: Float, normalizedY: Float)

Steamworks ISteamRemotePlay::SetMousePosition()

Declaration
Swift
public func setMousePosition(
    sessionID: RemotePlaySessionID, normalizedX: Float, normalizedY: Float)

func setMouseVisibility(sessionID: RemotePlaySessionID, visible: Bool)

Steamworks ISteamRemotePlay::SetMouseVisibility()

Declaration
Swift
public func setMouseVisibility(sessionID: RemotePlaySessionID, visible: Bool)

func showRemotePlayTogetherUI() -> Bool

Steamworks ISteamRemotePlay::ShowRemotePlayTogetherUI()

Declaration
Swift
public func showRemotePlayTogetherUI() -> Bool

func getInput() -> [RemotePlayInput]

Note

Provided by module SteamworksHelpers.

Steamworks ISteamRemotePlay::GetInput()

Declaration
Swift
public func getInput() -> [RemotePlayInput]