org.xith3d.base
Interface EnvScreenshotEngine

All Superinterfaces:
ScreenshotEngine

public interface EnvScreenshotEngine
extends ScreenshotEngine

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


Method Summary
 java.io.File takeScreenshot(Canvas3D canvas, boolean alpha)
          Takes a screenshot of the current rendering.
 void takeScreenshot(Canvas3D canvas, java.io.File file, boolean alpha)
          Takes a screenshot of the current rendering.
 java.io.File takeScreenshot(Canvas3D canvas, java.lang.String filenameBase, boolean alpha)
          Takes a screenshot of the current rendering.
 
Methods inherited from interface org.xith3d.utility.screenshots.ScreenshotEngine
takeScreenshot, takeScreenshot, takeScreenshot
 

Method Detail

takeScreenshot

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

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

takeScreenshot

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

Parameters:
canvas - the canvas to take the screenshot from
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(Canvas3D canvas,
                            boolean alpha)
Takes a screenshot of the current rendering.

Parameters:
canvas - the canvas to take the screenshot from
alpha - with alpha channel?
Returns:
the file where the screenshot has been saved