Drag[en]gine Script Module DragonScript  1.23
Dragengine.Debugging.DebugCaptureCanvasView Class Reference

Debug element class saving the content of a canvas view into a file. More...

Inheritance diagram for Dragengine.Debugging.DebugCaptureCanvasView:
Dragengine.Utils.FrameUpdateListener

Public Member Functions

void frameUpdate (float elapsed)
 Frame update. More...
 
DebugCaptureCanvasView new (String filename, CanvasView canvasView)
 Start capturing canvas view into file. More...
 
DebugCaptureCanvasView new (String filename, CanvasView canvasView, Console console)
 Start capturing canvas view into file and add console message if finished. More...
 
DebugCaptureCanvasView new (String filename, Widget widget)
 Start capturing widget into file. More...
 
DebugCaptureCanvasView new (String filename, Widget widget, Console console)
 Start capturing widget into file and add console message if finished. More...
 
- Public Member Functions inherited from Dragengine.Utils.FrameUpdateListener
FrameUpdateManager getFrameUpdateManager ()
 Frame update manager the listener is registered at. More...
 
void giveUp ()
 Remove listener from manager if registered at one. More...
 
FrameUpdateListener new ()
 Create listener registered at default frame update listener. More...
 
FrameUpdateListener new (FrameUpdateManager manager)
 Create listener registered at frame update manager. More...
 

Protected Member Functions

void onCaptureFailed ()
 Capture failed. More...
 
void onCaptureSucceeded ()
 Capture succeeded. More...
 

Detailed Description

Debug element class saving the content of a canvas view into a file.

To use create instance of this class with the filename and canvas view to capture. The class keeps itself alive as long as the capturing takes place. There is no need to store the created instance. If a console is set the class will add a message if the capturing finished successfully. Uses by default BaseGameApp console if present.

Member Function Documentation

◆ frameUpdate()

void Dragengine.Debugging.DebugCaptureCanvasView.frameUpdate ( float  elapsed)

Frame update.

Reimplemented from Dragengine.Utils.FrameUpdateListener.

◆ new() [1/4]

DebugCaptureCanvasView Dragengine.Debugging.DebugCaptureCanvasView.new ( String  filename,
CanvasView  canvasView 
)

Start capturing canvas view into file.

◆ new() [2/4]

DebugCaptureCanvasView Dragengine.Debugging.DebugCaptureCanvasView.new ( String  filename,
CanvasView  canvasView,
Console  console 
)

Start capturing canvas view into file and add console message if finished.

◆ new() [3/4]

DebugCaptureCanvasView Dragengine.Debugging.DebugCaptureCanvasView.new ( String  filename,
Widget  widget 
)

Start capturing widget into file.

◆ new() [4/4]

DebugCaptureCanvasView Dragengine.Debugging.DebugCaptureCanvasView.new ( String  filename,
Widget  widget,
Console  console 
)

Start capturing widget into file and add console message if finished.

◆ onCaptureFailed()

void Dragengine.Debugging.DebugCaptureCanvasView.onCaptureFailed ( )
protected

Capture failed.

◆ onCaptureSucceeded()

void Dragengine.Debugging.DebugCaptureCanvasView.onCaptureSucceeded ( )
protected

Capture succeeded.


The documentation for this class was generated from the following file: