org.xith3d.utility.screenshots
Interface ScreenshotEngine

All Known Subinterfaces:
EnvScreenshotEngine
All Known Implementing Classes:
Canvas3D

public interface ScreenshotEngine

A class implementing this interface is able to produce screenshots of the current scene thread sefely.


Method Summary
 java.io.File takeScreenshot(boolean alpha)
          Takes a screenshot of the current rendering of the first added Canvas3D.
 void takeScreenshot(java.io.File file, boolean alpha)
          Takes a screenshot of the current rendering.
 java.io.File takeScreenshot(java.lang.String filenameBase, boolean alpha)
          Takes a screenshot of the current rendering.
 

Method Detail

takeScreenshot

void takeScreenshot(java.io.File file,
                    boolean alpha)
Takes a screenshot of the current rendering.

Parameters:
file - the file to save the screenshot to
alpha - with alpha channel?

takeScreenshot

java.io.File takeScreenshot(java.lang.String filenameBase,
                            boolean alpha)
Takes a screenshot of the current rendering.

Parameters:
filenameBase - the filenameBase to save the screenshot to (e.g. "screens/shot") The current date and ".png" are appended.
alpha - with alpha channel?
Returns:
the file where the screenshot has been saved

takeScreenshot

java.io.File takeScreenshot(boolean alpha)
Takes a screenshot of the current rendering of the first added Canvas3D.

Parameters:
alpha - with alpha channel?
Returns:
the file where the screenshot has been saved