fm.liveswitch.ScreenConfig Class Reference

A screen configuration. More...

Public Member Functions

double getFrameRate ()
 Gets the frame-rate. More...
 
int getHeight ()
 Gets the region size height. More...
 
fm.liveswitch.Point getOrigin ()
 Gets the region origin. More...
 
fm.liveswitch.Rectangle getRegion ()
 Gets the region. More...
 
fm.liveswitch.Size getSize ()
 Gets the region size. More...
 
int getWidth ()
 Gets the region size width. More...
 
int getX ()
 Gets the region origin X coordinate. More...
 
int getY ()
 Gets the region origin Y coordinate. More...
 
boolean isEquivalent (fm.liveswitch.ScreenConfig config)
 Determines whether the specified configuration is equivalent. More...
 
 ScreenConfig (fm.liveswitch.Point origin, fm.liveswitch.Size size, double frameRate)
 Initializes a new instance of the fm.liveswitch.ScreenConfig class. More...
 
 ScreenConfig (fm.liveswitch.Point origin, fm.liveswitch.Size size, double frameRate, int clockRate)
 Initializes a new instance of the fm.liveswitch.ScreenConfig class. More...
 
 ScreenConfig (fm.liveswitch.Rectangle region, double frameRate)
 Initializes a new instance of the fm.liveswitch.ScreenConfig class. More...
 
 ScreenConfig (fm.liveswitch.Rectangle region, double frameRate, int clockRate)
 Initializes a new instance of the fm.liveswitch.ScreenConfig class. More...
 
 ScreenConfig (int x, int y, int width, int height, double frameRate)
 Initializes a new instance of the fm.liveswitch.ScreenConfig class. More...
 
 ScreenConfig (int x, int y, int width, int height, double frameRate, int clockRate)
 Initializes a new instance of the fm.liveswitch.ScreenConfig class. More...
 
void setFrameRate (double value)
 Sets the frame-rate. More...
 
void setOrigin (fm.liveswitch.Point value)
 Sets the region origin. More...
 
void setRegion (fm.liveswitch.Rectangle value)
 Sets the region. More...
 
void setSize (fm.liveswitch.Size value)
 Sets the region size. More...
 
String toString ()
 Returns a string that represents this instance. More...
 

Detailed Description

A screen configuration.

Constructor & Destructor Documentation

◆ ScreenConfig() [1/6]

fm.liveswitch.ScreenConfig.ScreenConfig ( fm.liveswitch.Point  origin,
fm.liveswitch.Size  size,
double  frameRate 
)

Initializes a new instance of the fm.liveswitch.ScreenConfig class.

Parameters
originThe region origin.
sizeThe region size.
frameRateThe frame rate.

◆ ScreenConfig() [2/6]

fm.liveswitch.ScreenConfig.ScreenConfig ( fm.liveswitch.Point  origin,
fm.liveswitch.Size  size,
double  frameRate,
int  clockRate 
)

Initializes a new instance of the fm.liveswitch.ScreenConfig class.

Parameters
originThe region origin.
sizeThe region size.
frameRateThe frame rate.
clockRateThe clock rate.

◆ ScreenConfig() [3/6]

fm.liveswitch.ScreenConfig.ScreenConfig ( fm.liveswitch.Rectangle  region,
double  frameRate 
)

Initializes a new instance of the fm.liveswitch.ScreenConfig class.

Parameters
regionThe region.
frameRateThe frame rate.

◆ ScreenConfig() [4/6]

fm.liveswitch.ScreenConfig.ScreenConfig ( fm.liveswitch.Rectangle  region,
double  frameRate,
int  clockRate 
)

Initializes a new instance of the fm.liveswitch.ScreenConfig class.

Parameters
regionThe region.
frameRateThe frame rate.
clockRateThe clock rate.

◆ ScreenConfig() [5/6]

fm.liveswitch.ScreenConfig.ScreenConfig ( int  x,
int  y,
int  width,
int  height,
double  frameRate 
)

Initializes a new instance of the fm.liveswitch.ScreenConfig class.

Parameters
xThe region origin X coordinate.
yThe region origin Y coordinate.
widthThe region size width.
heightThe region size height.
frameRateThe frame rate.

◆ ScreenConfig() [6/6]

fm.liveswitch.ScreenConfig.ScreenConfig ( int  x,
int  y,
int  width,
int  height,
double  frameRate,
int  clockRate 
)

Initializes a new instance of the fm.liveswitch.ScreenConfig class.

Parameters
xThe region origin X coordinate.
yThe region origin Y coordinate.
widthThe region size width.
heightThe region size height.
frameRateThe frame rate.
clockRateThe clock rate.

Member Function Documentation

◆ getFrameRate()

double fm.liveswitch.ScreenConfig.getFrameRate ( )

Gets the frame-rate.

◆ getHeight()

int fm.liveswitch.ScreenConfig.getHeight ( )

Gets the region size height.

◆ getOrigin()

fm.liveswitch.Point fm.liveswitch.ScreenConfig.getOrigin ( )

Gets the region origin.

◆ getRegion()

fm.liveswitch.Rectangle fm.liveswitch.ScreenConfig.getRegion ( )

Gets the region.

◆ getSize()

fm.liveswitch.Size fm.liveswitch.ScreenConfig.getSize ( )

Gets the region size.

◆ getWidth()

int fm.liveswitch.ScreenConfig.getWidth ( )

Gets the region size width.

◆ getX()

int fm.liveswitch.ScreenConfig.getX ( )

Gets the region origin X coordinate.

◆ getY()

int fm.liveswitch.ScreenConfig.getY ( )

Gets the region origin Y coordinate.

◆ isEquivalent()

boolean fm.liveswitch.ScreenConfig.isEquivalent ( fm.liveswitch.ScreenConfig  config)

Determines whether the specified configuration is equivalent.

Parameters
configThe configuration.

◆ setFrameRate()

void fm.liveswitch.ScreenConfig.setFrameRate ( double  value)

Sets the frame-rate.

◆ setOrigin()

void fm.liveswitch.ScreenConfig.setOrigin ( fm.liveswitch.Point  value)

Sets the region origin.

◆ setRegion()

void fm.liveswitch.ScreenConfig.setRegion ( fm.liveswitch.Rectangle  value)

Sets the region.

◆ setSize()

void fm.liveswitch.ScreenConfig.setSize ( fm.liveswitch.Size  value)

Sets the region size.

◆ toString()

String fm.liveswitch.ScreenConfig.toString ( )

Returns a string that represents this instance.