ScreenShot Messages

Action Messages

• SAVE_SCREENSHOT - Saves the screenshot at the present resolution to the specified file. Note that if the width and height dimensions of the view are not a power of two then they will be rounded up to the nearest power of two value. This message will trigger the following response messages: SCREENSHOT_SAVED. This default maximum wait time for this message is 20.

  Parameters:

  • filename (unicode) - The file where the screenshot will be saved.

  • AAlevel (int) - The level of software anti-aliasing to apply: 0 to 9.

  • selectionHighlighting (bool) - True to include selection highlighting in the saved image, False to save the image with no highlighting.

• SAVE_SCREENSHOT_AT_RESOLUTION - Saves the screenshot at the specified resolution to the specified file. Note that the width and height dimensions should be a power of two. If they are not then they will be rounded up to the nearest power of two value. This message will trigger the following response messages: SCREENSHOT_SAVED. This default maximum wait time for this message is 20.

  Parameters:

  • filename (unicode) - The name of the destination image file.

  • width (int) - The width of the image.

  • height (int) - The height of the image.

  • what (int) - 1 - 3d scene only; 2 - environment only; 3 - 3d scene and environment; 5 - 3d scene and overlay; 6 - environment and overlay; 7 - 3d scene, environment and overlay; 8 - 3d scene, environment and 3d GUI.

  • AAlevel (int) - The level of software anti-aliasing to apply: 0 to 9.

  • selectionHighlighting (bool) - True to include selection highlighting in the saved image, False to save the image with no highlighting.

• SAVE_SCREENSHOT_PARAMETERS - Save a screenshot to a given filename using a set of parameters.

  Parameters:

  • filename (unicode) - The name of the destination image file.

  • parameters (tuple) - Parameters: width, height, what, AAlevel, selectionHighlighting, densityUnit, density.

• SAVE_VIEWPORT - Save a screenshot to a given filename using a set of parameters.

  Parameters:

  • filename (unicode) - The name of the destination image file.

  • parameters (tuple) - Parameters: width, height, what, AAlevel, selectionHighlighting, densityUnit, density.

• SCREENSNAP_SET_RESOLUTION - Sets the X and Y value of the screensnap resolution.

  Parameters:

  • width (float) - The screensnap width in pixels.

  • height (float) - The screensnap height in pixels.

• SCREENSNAP_UI_SET_MODE - Shows or hides the Screen Snapshot user interface (black crop bars).

  Parameters:

  • visible (bool) - True to show the Screen Snapshot user interface, False to hide it.

Response Messages

• SCREENSHOT_SAVED - Indicates that your screenshot save is completed.

  Parameters:

  • filename (unicode) - The file where the screenshot was saved.