steam_send_screenshot

Upload a screenshot to the users Steam Community profile.

Syntax:

steam_send_screenshot(filename, width, height);


Argument Description
filename The name of the image file to upload (a string).
width The width of the image (an integer).
height The height of the image (an integer).


Returns: Real


Description

With this function you can upload a screenshot to the Steam Community profile page of the currently logged in user. The filename you supply is the name of the local file that was created when you took the screenshot using the GameMaker: Studio functions screen_save or screen_save_part. The width and height define the image size, and the function will return a value of 0 if it fails for whatever reason and a value greater than 0 if it succeeds.


Example:

if steam_is_screenshot_requested()
   {
   var file = "Catch_The_Haggis_" + string(global.scrn_num) + ".png");
   screen_save(file)
   steam_send_screenshot(file, window_get_width(), window_get_height());
   global.scrn_num += 1;
   }

The above code will poll the Steam API for a screenshot request and if it has been, a unique name for the image file will be generated, a screenshot will be taken, and the file will be sent to the Steam Community page for the user.


Back: Steam API
Next: steam_user_owns_dlc
© Copyright YoYo Games Ltd. 2018 All Rights Reserved