FalcoEngine.QualitySettings Class Reference

Public Types
enum	ShadowsQualityLevel {   Level1 , Level2 , Level3 , Level4 ,   Level5 , Level6 }
	Shadows quality level enum More...
enum	ShadowsCascadesCount { Two , Three , Four }
	Shadows cascades count enum More...
enum	ShadowsSoftenessLevel { Off , Low , Normal , High }
	Shadows softeness level enum More...

Public Member Functions
static void	SetWindowSize (int width, int height)
	Set window size More...
static int	GetWindowWidth ()
	Return window width More...
static int	GetWindowHeight ()
	Return window height More...
static void	SetFullScreen (bool value)
	Set window fullscreen More...
static bool	GetFullScreen ()
	Return true if window is in fullscreen More...
static void	SetExclusiveMode (bool value)
	Set window should run in exclusive mode and switch display resolution if needed More...
static bool	GetExclusiveMode ()
	Return true if window is running in exclusive mode More...
static void	SetVSync (bool value)
	Set V-Sync enabled or not More...
static bool	GetVSync ()
	Return true if V-Sync is enabled More...
static void	SetFXAA (bool value)
	Set use FXAA anti aliasing More...
static bool	GetFXAA ()
	Return true if FXAA anti aliasing is enabled More...
static void	SetDynamicResolution (bool value)
	Set use back buffer dynamic resolution More...
static bool	GetDynamicResolution ()
	Returns if back buffer dynamic resolution is using More...
static void	SetDynamicResolutionValue (float value)
	Set back buffer resolution ratio (from 0.5 to 1) More...
static float	GetDynamicResolutionValue ()
	Return back buffer resolution ratio More...
static void	SetAutoDynamicResolution (bool value)
	Set use auto back buffer dynamic resolution More...
static bool	GetAutoDynamicResolution ()
	Returns if auto back buffer dynamic resolution is using More...
static void	SetAutoDynamicResolutionTargetFPS (int value)
	Set target frames per second for auto dynamic resolution More...
static int	GetAutoDynamicResolutionTargetFPS ()
	Return target frames per second for auto dynamic resolution More...
static void	SetShadowsDistance (float value)
	Set distance in which shadows will be visible More...
static float	GetShadowsDistance ()
	Return shadows distance More...
static void	SetShadowsEnabled (bool value)
	Enable/disable shadows More...
static bool	GetShadowsEnabled ()
	Returns if shadows are enabled More...

Static Public Member Functions
static void	SetDirectionalShadowsQuality (ShadowsQualityLevel qualityLevel)
	Set directional shadows quality More...
static ShadowsQualityLevel	GetDirectionalShadowsQuality ()
	Return directional shadows quality More...
static void	SetPointShadowsQuality (ShadowsQualityLevel qualityLevel)
	Set point shadows quality More...
static ShadowsQualityLevel	GetPointShadowsQuality ()
	Return point shadows quality More...
static void	SetSpotShadowsQuality (ShadowsQualityLevel qualityLevel)
	Set spot shadows quality More...
static ShadowsQualityLevel	GetSpotShadowsQuality ()
	Return spot shadows quality More...
static void	SetShadowsCascadesCount (ShadowsCascadesCount cascadesCount)
	Set shadows cascades count (for directional lights only) More...
static ShadowsCascadesCount	GetShadowsCascadesCount ()
	Return shadows cascades count More...
static void	SetShadowsSofteness (ShadowsSoftenessLevel shadowsSofteness)
	Set shadows softeness More...
static ShadowsSoftenessLevel	GetShadowsSofteness ()
	Return shadows softeness More...

Detailed Description

Definition at line 9 of file QualitySettings.cs.

Member Enumeration Documentation

ShadowsCascadesCount

enum FalcoEngine.QualitySettings.ShadowsCascadesCount

Shadows cascades count enum

Enumerator
Two
Three
Four

Definition at line 29 of file QualitySettings.cs.

ShadowsQualityLevel

enum FalcoEngine.QualitySettings.ShadowsQualityLevel

Shadows quality level enum

Enumerator
Level1
Level2
Level3
Level4
Level5
Level6

Definition at line 16 of file QualitySettings.cs.

ShadowsSoftenessLevel

enum FalcoEngine.QualitySettings.ShadowsSoftenessLevel

Shadows softeness level enum

Enumerator
Off
Low
Normal
High

Definition at line 39 of file QualitySettings.cs.

Member Function Documentation

GetAutoDynamicResolution()

static bool FalcoEngine.QualitySettings.GetAutoDynamicResolution

(

)

Returns if auto back buffer dynamic resolution is using

Returns

GetAutoDynamicResolutionTargetFPS()

static int FalcoEngine.QualitySettings.GetAutoDynamicResolutionTargetFPS

(

)

Return target frames per second for auto dynamic resolution

Returns

GetDirectionalShadowsQuality()

static ShadowsQualityLevel FalcoEngine.QualitySettings.GetDirectionalShadowsQuality ( )

static

Return directional shadows quality

Returns

Definition at line 204 of file QualitySettings.cs.

GetDynamicResolution()

static bool FalcoEngine.QualitySettings.GetDynamicResolution

(

)

Returns if back buffer dynamic resolution is using

Returns

GetDynamicResolutionValue()

static float FalcoEngine.QualitySettings.GetDynamicResolutionValue

(

)

Return back buffer resolution ratio

Returns

GetExclusiveMode()

static bool FalcoEngine.QualitySettings.GetExclusiveMode

(

)

Return true if window is running in exclusive mode

Returns

GetFullScreen()

static bool FalcoEngine.QualitySettings.GetFullScreen

(

)

Return true if window is in fullscreen

Returns

GetFXAA()

static bool FalcoEngine.QualitySettings.GetFXAA

(

)

Return true if FXAA anti aliasing is enabled

Returns

GetPointShadowsQuality()

static ShadowsQualityLevel FalcoEngine.QualitySettings.GetPointShadowsQuality ( )

static

Return point shadows quality

Returns

Definition at line 230 of file QualitySettings.cs.

GetShadowsCascadesCount()

static ShadowsCascadesCount FalcoEngine.QualitySettings.GetShadowsCascadesCount ( )

static

Return shadows cascades count

Returns

Definition at line 282 of file QualitySettings.cs.

GetShadowsDistance()

static float FalcoEngine.QualitySettings.GetShadowsDistance

(

)

Return shadows distance

Returns

GetShadowsEnabled()

static bool FalcoEngine.QualitySettings.GetShadowsEnabled

(

)

Returns if shadows are enabled

Returns

GetShadowsSofteness()

static ShadowsSoftenessLevel FalcoEngine.QualitySettings.GetShadowsSofteness ( )

static

Return shadows softeness

Returns

Definition at line 308 of file QualitySettings.cs.

GetSpotShadowsQuality()

static ShadowsQualityLevel FalcoEngine.QualitySettings.GetSpotShadowsQuality ( )

static

Return spot shadows quality

Returns

Definition at line 256 of file QualitySettings.cs.

GetVSync()

static bool FalcoEngine.QualitySettings.GetVSync

(

)

Return true if V-Sync is enabled

Returns

GetWindowHeight()

static int FalcoEngine.QualitySettings.GetWindowHeight

(

)

Return window height

Returns

GetWindowWidth()

static int FalcoEngine.QualitySettings.GetWindowWidth

(

)

Return window width

Returns

SetAutoDynamicResolution()

static void FalcoEngine.QualitySettings.SetAutoDynamicResolution

(

bool

value

)

Set use auto back buffer dynamic resolution

Parameters

value

SetAutoDynamicResolutionTargetFPS()

static void FalcoEngine.QualitySettings.SetAutoDynamicResolutionTargetFPS

(

int

value

)

Set target frames per second for auto dynamic resolution

Parameters

value

SetDirectionalShadowsQuality()

static void FalcoEngine.QualitySettings.SetDirectionalShadowsQuality ( ShadowsQualityLevel  qualityLevel )

static

Set directional shadows quality

Parameters

qualityLevel

Definition at line 195 of file QualitySettings.cs.

SetDynamicResolution()

static void FalcoEngine.QualitySettings.SetDynamicResolution

(

bool

value

)

Set use back buffer dynamic resolution

Parameters

value

SetDynamicResolutionValue()

static void FalcoEngine.QualitySettings.SetDynamicResolutionValue

(

float

value

)

Set back buffer resolution ratio (from 0.5 to 1)

Parameters

value

SetExclusiveMode()

static void FalcoEngine.QualitySettings.SetExclusiveMode

(

bool

value

)

Set window should run in exclusive mode and switch display resolution if needed

Parameters

value

SetFullScreen()

static void FalcoEngine.QualitySettings.SetFullScreen

(

bool

value

)

Set window fullscreen

Parameters

value

SetFXAA()

static void FalcoEngine.QualitySettings.SetFXAA

(

bool

value

)

Set use FXAA anti aliasing

Parameters

value

SetPointShadowsQuality()

static void FalcoEngine.QualitySettings.SetPointShadowsQuality ( ShadowsQualityLevel  qualityLevel )

static

Set point shadows quality

Parameters

qualityLevel

Definition at line 221 of file QualitySettings.cs.

SetShadowsCascadesCount()

static void FalcoEngine.QualitySettings.SetShadowsCascadesCount ( ShadowsCascadesCount  cascadesCount )

static

Set shadows cascades count (for directional lights only)

Parameters

cascadesCount

Definition at line 273 of file QualitySettings.cs.

SetShadowsDistance()

static void FalcoEngine.QualitySettings.SetShadowsDistance

(

float

value

)

Set distance in which shadows will be visible

Parameters

value

SetShadowsEnabled()

static void FalcoEngine.QualitySettings.SetShadowsEnabled

(

bool

value

)

Enable/disable shadows

Parameters

value

SetShadowsSofteness()

static void FalcoEngine.QualitySettings.SetShadowsSofteness ( ShadowsSoftenessLevel  shadowsSofteness )

static

Set shadows softeness

Parameters

shadowsSofteness

Definition at line 299 of file QualitySettings.cs.

SetSpotShadowsQuality()

static void FalcoEngine.QualitySettings.SetSpotShadowsQuality ( ShadowsQualityLevel  qualityLevel )

static

Set spot shadows quality

Parameters

qualityLevel

Definition at line 247 of file QualitySettings.cs.

SetVSync()

static void FalcoEngine.QualitySettings.SetVSync

(

bool

value

)

Set V-Sync enabled or not

Parameters

value

SetWindowSize()

static void FalcoEngine.QualitySettings.SetWindowSize	(	int	width,
		int	height
	)

Set window size

Parameters

width
height

---

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

• API/Other/QualitySettings.cs