Functions - Screenshots
addScreenshotToLibrary
addScreenshotToLibrary( string
filename, string
thumbnail_filename, int
width, int
height )
Adds a screenshot to the user's Steam screenshot library from disk.
Returns: uint32_t
addVRScreenshotToLibrary
addVRScreenshotToLibrary( int
type, string
filename, string
vr_filename )
Adds a VR screenshot to the user's Steam screenshot library from disk in the supported type.
Returns: uint32_t
hookScreenshots
hookScreenshots( bool
hook )
Toggles whether the overlay handles screenshots.
Returns: void
isScreenshotsHooked
isScreenshotsHooked()
Checks if the app is hooking screenshots.
Returns: bool
setLocation
setLocation( uint32_t
screenshot, string
location )
Sets optional metadata about a screenshot's location.
Returns: bool
tagPublishedFile
tagPublishedFile( uint32_t
screenshot, uint64_t
file_id )
Tags a published file as being visible in the screenshot.
Returns: bool
tagUser
tagUser( uint32_t
screenshot, uint64_t
steam_id )
Tags a Steam user as being visible in the screenshot. You can tag up to the value declared by k_nScreenshotMaxTaggedUsers in a single screenshot. Tagging more users than that will just be discarded. This function has a built in delay before saving the tag which allows you to call it repeatedly for each item. You can get the handle to tag the screenshot once it has been successfully saved from the screenshot_ready callback or via the WriteScreenshot, AddScreenshotToLibrary, AddVRScreenshotToLibrary calls.
Returns: bool
triggerScreenshot
triggerScreenshot()
Causes Steam overlay to take a screenshot.
Returns: void
writeScreenshot
writeScreenshot( PoolByteArray
rgb, int
width, int
height )
Writes a screenshot to the user's Steam screenshot library.
Returns: uint32_t