Skip to content

Screenshots

The Screenshots subsystem provides access to the Steam Screenshots system, allowing the game to trigger screenshots, add custom images to the Steam screenshot library, and react to screenshot-related events.

This subsystem supports both standard Steam screenshots and custom screenshot workflows, making it suitable for in-game photo modes and automated capture features.


Capabilities

  • Trigger a standard Steam screenshot using the Steam screenshot flow.
  • Add screenshots to the Steam library from image files.
  • Add screenshots to the Steam library from raw RGBA pixel data.
  • Assign custom location metadata to screenshots.
  • Subscribe to screenshot requested events.
  • Subscribe to screenshot ready events with result information.

Important Notes

  • Screenshot handling depends on Steam client settings and user permissions.
  • Custom screenshots must follow Steam image format and size requirements.
  • Screenshot events are delivered asynchronously via Steam callbacks.
  • The subsystem does not manage image encoding or file persistence beyond Steam integration.