ViewConfig

Scaleform::Platform

struct ViewConfig {
  unsigned ViewFlags;
  int ColorBits;
  int DepthBits;
  int StencilBits;
  Size<unsigned> ViewSize;
  unsigned Orientation;
  unsigned StereoFormat;
  Point<int> WindowPos;
  Size<unsigned> MinSize;
  const Args* CommandLineArgs;
};

Description

ViewConfig is a structure describing the viewport configuration settings.

Data Members

Data Member	Description
ColorBits	The requested number of bits in the color buffer (-1 will use platform default).
CommandLineArgs	The args passed to the App on the commandline.
DepthBits	The requested number of bits in the depth buffer (-1 will use platform default).
MinSize	Minimum size of the window.
Orientation	Screen orientation.
StencilBits	The requested number of bits in the stencil buffer (-1 will use platform default).
StereoFormat	The Stereo mode set for the viewport.
ViewFlags	Bit-flags for configuration. See ViewFlagConstants.
ViewSize	The size of the viewport.
WindowPos	The position of the window.

Methods

Method	Description
ClearPos	Clears the window position.
ClearSize	Clears the window size.
GetInitHALConfigFlags	Converts the platform agnostic flags (only) from ViewConfig flags.
GetMinSize	Returns the minimum size of the window.
GetPos	Returns the window position.
GetSize	Returns the window size.
GetViewportFlags	Returns the viewport flags set for the window.
HasFlag	Checks if the viewport flags are set for the current window.
SetFlag	Sets the viewport flags for the window.
SetMinSize	Sets the minimum size of the window.
SetPos	Sets the position of the window.
SetSize	Sets the size of the view window.
ViewConfig	ViewConfig constructor.

File

Platform.h