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

Graphic system. More...

Inheritance diagram for Dragengine.GraphicSystem:

Static Public Member Functions

Management
static int getWindowWidth ()
 Width in pixel of render window. More...
 
static int getWindowHeight ()
 Height in pixel of the render window. More...
 
static Point getWindowSize ()
 Size in pixels of render window. More...
 
static void setWindowGeometry (int width, int height, bool fullScreen)
 Set render window geometry. More...
 
static void setWindowTitle (String title)
 Set render window title. More...
 
static CanvasView getPrimaryCanvas ()
 Primary canvas view. More...
 
Parameters
static int getParameterCount ()
 Number of parameters available. More...
 
static ModuleParameter getParameterInfo (int index)
 Parameter information. More...
 
static ModuleParameter getParameterInfo (String name)
 Named parameter information or null if not found. More...
 
static String getParameterValue (String name)
 Parameter value. More...
 
static void setParameterValue (String name, String value)
 Set named parameter value. More...
 
static String sendCommand (String command)
 Send command. More...
 
static int getFPSRate ()
 Frame-per-second rate averaged over the last couple of frames. More...
 
static void setVRDebugPanelPosition (DVector position, Quaternion orientation)
 Set position and orientation of VR debug panel if graphic module shows one. More...
 

Detailed Description

Graphic system.

This is a native class. This is a pure static class. The class can not be instantiated

Member Function Documentation

◆ getFPSRate()

static int Dragengine.GraphicSystem.getFPSRate ( )
static

Frame-per-second rate averaged over the last couple of frames.

Version
1.6

Returns 0 if module is not using a separate thread.

◆ getParameterCount()

static int Dragengine.GraphicSystem.getParameterCount ( )
static

Number of parameters available.

◆ getParameterInfo() [1/2]

static ModuleParameter Dragengine.GraphicSystem.getParameterInfo ( int  index)
static

Parameter information.

Exceptions
EOutOfBoundaryindex less than 0 or greater than or equal to getParameterCount().

◆ getParameterInfo() [2/2]

static ModuleParameter Dragengine.GraphicSystem.getParameterInfo ( String  name)
static

Named parameter information or null if not found.

◆ getParameterValue()

static String Dragengine.GraphicSystem.getParameterValue ( String  name)
static

Parameter value.

Exceptions
EInvalidParamParameter with name not found.

◆ getPrimaryCanvas()

static CanvasView Dragengine.GraphicSystem.getPrimaryCanvas ( )
static

Primary canvas view.

◆ getWindowHeight()

static int Dragengine.GraphicSystem.getWindowHeight ( )
static

Height in pixel of the render window.

◆ getWindowSize()

static Point Dragengine.GraphicSystem.getWindowSize ( )
static

Size in pixels of render window.

◆ getWindowWidth()

static int Dragengine.GraphicSystem.getWindowWidth ( )
static

Width in pixel of render window.

◆ sendCommand()

static String Dragengine.GraphicSystem.sendCommand ( String  command)
static

Send command.

◆ setParameterValue()

static void Dragengine.GraphicSystem.setParameterValue ( String  name,
String  value 
)
static

Set named parameter value.

Exceptions
EInvalidParamParameter with name not found.

◆ setVRDebugPanelPosition()

static void Dragengine.GraphicSystem.setVRDebugPanelPosition ( DVector  position,
Quaternion  orientation 
)
static

Set position and orientation of VR debug panel if graphic module shows one.

Version
1.17

The debug panel is usually shown if the user looks at the back of his right hand like looking at a wrist watch. The position is the center of the debug panel with the size determined by the graphic module. The matrix defined by the orientation lines up with the panel like this:

  • matrix right vector along panel right direction
  • matrix up vector along panel down direction
  • matrix forward vector pointing towards the user

◆ setWindowGeometry()

static void Dragengine.GraphicSystem.setWindowGeometry ( int  width,
int  height,
bool  fullScreen 
)
static

Set render window geometry.

◆ setWindowTitle()

static void Dragengine.GraphicSystem.setWindowTitle ( String  title)
static

Set render window title.


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