Interface IFileImageRenderer

All Known Implementing Classes:
BasicFileImageRenderer, BufferedFileImageRenderer

public interface IFileImageRenderer
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Flushes the renderer causing the images to be written, if needed.
    saveScreenshot(String folder, String fileprefix, int w, int h, boolean immediate, Settings.ImageFormat type, float quality)
    Renders a screenshot in the given location with the given prefix and the given size.
  • Method Details

    • saveScreenshot

      String saveScreenshot(String folder, String fileprefix, int w, int h, boolean immediate, Settings.ImageFormat type, float quality)
      Renders a screenshot in the given location with the given prefix and the given size.
      Parameters:
      folder - Folder to save.
      fileprefix - The file name prefix.
      w - The width.
      h - The height.
      immediate - Forces synchronous immediate write to disk.
      type - The image type, JPG or PNG
      quality - The quality in the case of JPG in [0..1]
      Returns:
      String with the path to the screenshot image file
    • flush

      void flush()
      Flushes the renderer causing the images to be written, if needed.