VerticesEngine.vxScreen Class Reference

The Engine Graphical Settings Manager which holds all of settings for engine graphics such as resolution, fullscreen, vsync as well as other Depth of Field toggle or Cascade Shadow qaulity. More...

Static Public Member Functions
static void	SetWindowPos (int x, int y)
	Set's the Window Position.
static void	SetResolution (int x, int y)
	Sets the resolution.
static void	SetResolution (Point point)
	Sets the resolution.
static void	SetSafeArea (Vector4 margin)
	Sets the Safe Area margin.
static void	SetSafeArea (int x, int y, int z, int w)
	Sets the Safe Area margin.
static void	RefreshGraphics ()
	Applies the Current Graphics Settings list Resolution and Fullscreen.
static Texture2D	TakeScreenshot (bool forceFrameDraw=false, bool suppressUI=false, bool suppressSandboxItems=true)
	Takes a screenshot.
static void	DebugDump (string area)

Properties
static Point	Resolution [get]
	Gets or sets the resolution from 'Engine.Settings.Graphics.Screen'. NOTE: Apply needs to be called to apply these settings.
static int	Width [get, set]
	Screen Width. You must call RefreshGraphics() to apply this change.
static int	Height [get, set]
	Screen Height. You must call RefreshGraphics() to apply this change.
static vxFullScreenMode	FullScreenMode [get, set]
	Gets or sets a value from 'Engine.Settings.Graphics.Screen' indicating whether this instance is full screen. NOTE: Apply needs to be called to apply these settings.
static bool	IsVSyncOn [get, set]
	Gets or sets a value indicating whether this T:VerticesEngine.Graphics.vxGraphicsSettingsManager is VS ync on.
static Viewport	SafeArea [get]
	The currently configured Safe Aera.
static Viewport	Viewport [get]
	The viewport for the screen. Note this can be scaled and stretched to match DPI and window settings. This can be different than SafeArea
static bool	IsTakingScreenshot [get]
	Our we currently taking a screenshot while rendering? This is useful for setting specific render settings if we are taking a screenshot.

Events
static Action	OnScreenResChanged = () => { }
	Called when ever the Graphics Settings are refreshed and applied.

Detailed Description

The Engine Graphical Settings Manager which holds all of settings for engine graphics such as resolution, fullscreen, vsync as well as other Depth of Field toggle or Cascade Shadow qaulity.

Member Function Documentation

SetResolution() [1/2]

static void VerticesEngine.vxScreen.SetResolution ( int x, int y )

static

Sets the resolution.

Parameters

x
y

SetResolution() [2/2]

static void VerticesEngine.vxScreen.SetResolution ( Point point )

static

Sets the resolution.

Parameters

point

SetSafeArea() [1/2]

static void VerticesEngine.vxScreen.SetSafeArea ( int x, int y, int z, int w )

static

Sets the Safe Area margin.

Parameters

x
y
z
w

SetSafeArea() [2/2]

static void VerticesEngine.vxScreen.SetSafeArea ( Vector4 margin )

static

Sets the Safe Area margin.

Parameters

margin

SetWindowPos()

static void VerticesEngine.vxScreen.SetWindowPos ( int x, int y )

static

Set's the Window Position.

Parameters

x
y

Property Documentation

FullScreenMode

vxFullScreenMode VerticesEngine.vxScreen.FullScreenMode

staticgetset

Gets or sets a value from 'Engine.Settings.Graphics.Screen' indicating whether this instance is full screen. NOTE: Apply needs to be called to apply these settings.

true if this instance is full screen; otherwise, false.

IsVSyncOn

bool VerticesEngine.vxScreen.IsVSyncOn

staticgetset

Gets or sets a value indicating whether this T:VerticesEngine.Graphics.vxGraphicsSettingsManager is VS ync on.

true if is VS ync on; otherwise, false.

Resolution

Point VerticesEngine.vxScreen.Resolution

staticget

Gets or sets the resolution from 'Engine.Settings.Graphics.Screen'. NOTE: Apply needs to be called to apply these settings.

The resolution.

---

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

• /github/workspace/src/VerticesEngine/src.shared/Graphics/vxScreen.cs