ISteamScreenshots

Note

This documentation is auto-generated. Methods marked with 🤖 are automatically generated bindings. Methods marked with ✍️ are manually implemented and methods marked with ✋ are currently not implemented.

List of Functions

List of Callbacks

Function Reference

Screenshots.AddScreenshotToLibrary(pchFilename, pchThumbnailFilename, nWidth, nHeight)

🤖 Auto-generated binding

Parameters:

  • pchFilename (str?) –

  • pchThumbnailFilename (str?) –

  • nWidth (int) –

  • nHeight (int) –

Returns:

(int - ScreenshotHandle) Return value

SteamWorks:

AddScreenshotToLibrary

Example:

local handle = Steam.Screenshots.AddScreenshotToLibrary('screenshot.png', nil, 1920, 1080)
if handle ~= 0 then
    Steam.Screenshots.SetLocation(handle, 'Main Menu')
end
Screenshots.AddVRScreenshotToLibrary(eType, pchFilename, pchVRFilename)

🤖 Auto-generated binding

Parameters:

  • eType (int - EVRScreenshotType) –

  • pchFilename (str?) –

  • pchVRFilename (str?) –

Returns:

(int - ScreenshotHandle) Return value

SteamWorks:

AddVRScreenshotToLibrary

Screenshots.HookScreenshots(bHook)

🤖 Auto-generated binding

Parameters:

bHook (bool) –

SteamWorks:

HookScreenshots

Example:

-- Intercept F12 screenshots to add game UI before saving
Steam.Screenshots.HookScreenshots(true)
Screenshots.IsScreenshotsHooked()

🤖 Auto-generated binding

Returns:

(bool) Return value

SteamWorks:

IsScreenshotsHooked

Screenshots.SetLocation(hScreenshot, pchLocation)

🤖 Auto-generated binding

Parameters:

  • hScreenshot (int - ScreenshotHandle) –

  • pchLocation (str?) –

Returns:

(bool) Return value

SteamWorks:

SetLocation

Example:

Steam.Screenshots.SetLocation(screenshotHandle, 'Boss Arena Level 5')
Screenshots.TagPublishedFile(hScreenshot, unPublishedFileID)

🤖 Auto-generated binding

Parameters:

  • hScreenshot (int - ScreenshotHandle) –

  • unPublishedFileID (uint64 - PublishedFileId_t) –

Returns:

(bool) Return value

SteamWorks:

TagPublishedFile

Screenshots.TagUser(hScreenshot, steamID)

🤖 Auto-generated binding

Parameters:

  • hScreenshot (int - ScreenshotHandle) –

  • steamID (uint64 - CSteamID) –

Returns:

(bool) Return value

SteamWorks:

TagUser

Screenshots.TriggerScreenshot()

🤖 Auto-generated binding

SteamWorks:

TriggerScreenshot

Example:

-- Programmatically take a Steam screenshot
Steam.Screenshots.TriggerScreenshot()
Screenshots.WriteScreenshot(pubRGB, cubRGB, nWidth, nHeight)

🤖 Auto-generated binding

Parameters:

  • pubRGB (str?) –

  • cubRGB (int) – size of the input array pubRGB

  • nWidth (int) –

  • nHeight (int) –

Returns:

(int - ScreenshotHandle) Return value

SteamWorks:

WriteScreenshot

Example:

-- Capture the current framebuffer and add to Steam library
local rgbData = captureFramebuffer()
local handle = Steam.Screenshots.WriteScreenshot(rgbData, #rgbData, screenWidth, screenHeight)

Callbacks

Screenshots.OnScreenshotReady()

Callback for ScreenshotReady_t

callback(data) receives:

  • data.m_hLocal (int - ScreenshotHandle)

  • data.m_eResult (int - EResult)

Example:

function Steam.Screenshots.OnScreenshotReady(data)
    if data.m_eResult == Steam.k_EResultOK then
        print('Screenshot saved, handle:', data.m_hLocal)
    end
end
Screenshots.OnScreenshotRequested()

Callback for ScreenshotRequested_t

callback(data) receives no fields (notification only).

Example:

function Steam.Screenshots.OnScreenshotRequested()
    -- User pressed F12; capture game state and submit
    local rgbData = captureFramebuffer()
    Steam.Screenshots.WriteScreenshot(rgbData, #rgbData, screenWidth, screenHeight)
end