Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Paradox.Graphics.PresentationParameters Class Reference

Describess how data will be displayed to the screen. More...

Inheritance diagram for SiliconStudio.Paradox.Graphics.PresentationParameters:
IEquatable< PresentationParameters >

Public Member Functions

 PresentationParameters ()
 Initializes a new instance of the PresentationParameters class with default values. More...
 
 PresentationParameters (int backBufferWidth, int backBufferHeight, WindowHandle deviceWindowHandle)
 Initializes a new instance of the PresentationParameters class with PixelFormat.R8G8B8A8_UNorm. More...
 
 PresentationParameters (int backBufferWidth, int backBufferHeight, WindowHandle deviceWindowHandle, PixelFormat backBufferFormat)
 Initializes a new instance of the PresentationParameters class. More...
 
PresentationParameters Clone ()
 
bool Equals (PresentationParameters other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static bool operator== (PresentationParameters left, PresentationParameters right)
 
static bool operator!= (PresentationParameters left, PresentationParameters right)
 

Public Attributes

PixelFormat BackBufferFormat
 A SharpDX.DXGI.Format structure describing the display format. More...
 
int BackBufferHeight
 A value that describes the resolution height. More...
 
int BackBufferWidth
 A value that describes the resolution width. More...
 
PixelFormat DepthStencilFormat
 Gets or sets the depth stencil format More...
 
WindowHandle DeviceWindowHandle
 A Window object. See remarks. More...
 
bool IsFullScreen
 Gets or sets a value indicating whether the application is in full screen mode. More...
 
MSAALevel MultiSampleCount
 Gets or sets a value indicating the number of sample locations during multisampling. More...
 
PresentInterval PresentationInterval
 Gets or sets the maximum rate at which the swap chain's back buffers can be presented to the front buffer. More...
 
Rational RefreshRate
 A structure describing the refresh rate in hertz More...
 
int PreferredFullScreenOutputIndex
 The output (monitor) index to use when switching to fullscreen mode. Doesn't have any effect when windowed mode is used. More...
 

Detailed Description

Describess how data will be displayed to the screen.

Definition at line 11 of file PresentationParameters.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Graphics.PresentationParameters.PresentationParameters ( )

Initializes a new instance of the PresentationParameters class with default values.

Definition at line 79 of file PresentationParameters.cs.

SiliconStudio.Paradox.Graphics.PresentationParameters.PresentationParameters ( int  backBufferWidth,
int  backBufferHeight,
WindowHandle  deviceWindowHandle 
)

Initializes a new instance of the PresentationParameters class with PixelFormat.R8G8B8A8_UNorm.

Parameters
backBufferWidthWidth of the back buffer.
backBufferHeightHeight of the back buffer.
deviceWindowHandleThe device window handle.

Definition at line 97 of file PresentationParameters.cs.

References SiliconStudio.Paradox.Graphics.R8G8B8A8_UNorm.

SiliconStudio.Paradox.Graphics.PresentationParameters.PresentationParameters ( int  backBufferWidth,
int  backBufferHeight,
WindowHandle  deviceWindowHandle,
PixelFormat  backBufferFormat 
)

Initializes a new instance of the PresentationParameters class.

Parameters
backBufferWidthWidth of the back buffer.
backBufferHeightHeight of the back buffer.
deviceWindowHandleThe device window handle.
backBufferFormatThe back buffer format.

Definition at line 109 of file PresentationParameters.cs.

Member Function Documentation

PresentationParameters SiliconStudio.Paradox.Graphics.PresentationParameters.Clone ( )

Definition at line 122 of file PresentationParameters.cs.

override bool SiliconStudio.Paradox.Graphics.PresentationParameters.Equals ( object  obj)

Definition at line 134 of file PresentationParameters.cs.

override int SiliconStudio.Paradox.Graphics.PresentationParameters.GetHashCode ( )

Definition at line 142 of file PresentationParameters.cs.

static bool SiliconStudio.Paradox.Graphics.PresentationParameters.operator!= ( PresentationParameters  left,
PresentationParameters  right 
)
static

Definition at line 165 of file PresentationParameters.cs.

static bool SiliconStudio.Paradox.Graphics.PresentationParameters.operator== ( PresentationParameters  left,
PresentationParameters  right 
)
static

Definition at line 160 of file PresentationParameters.cs.

Member Data Documentation

PixelFormat SiliconStudio.Paradox.Graphics.PresentationParameters.BackBufferFormat

A SharpDX.DXGI.Format structure describing the display format.

Definition at line 18 of file PresentationParameters.cs.

int SiliconStudio.Paradox.Graphics.PresentationParameters.BackBufferHeight

A value that describes the resolution height.

Definition at line 23 of file PresentationParameters.cs.

int SiliconStudio.Paradox.Graphics.PresentationParameters.BackBufferWidth

A value that describes the resolution width.

Definition at line 28 of file PresentationParameters.cs.

PixelFormat SiliconStudio.Paradox.Graphics.PresentationParameters.DepthStencilFormat

Gets or sets the depth stencil format

Definition at line 33 of file PresentationParameters.cs.

WindowHandle SiliconStudio.Paradox.Graphics.PresentationParameters.DeviceWindowHandle

A Window object. See remarks.

A window object is platform dependent:

  • On Windows Desktop: This could a low level window/control handle (IntPtr), or directly a Winform Control object.
  • On Windows Metro: This could be SwapChainBackgroundPanel or SwapChainPanel object.

Definition at line 45 of file PresentationParameters.cs.

Referenced by SiliconStudio.Paradox.Graphics.PresentationParameters.Equals().

bool SiliconStudio.Paradox.Graphics.PresentationParameters.IsFullScreen

Gets or sets a value indicating whether the application is in full screen mode.

Definition at line 50 of file PresentationParameters.cs.

MSAALevel SiliconStudio.Paradox.Graphics.PresentationParameters.MultiSampleCount

Gets or sets a value indicating the number of sample locations during multisampling.

Definition at line 55 of file PresentationParameters.cs.

Referenced by SiliconStudio.Paradox.Graphics.PresentationParameters.Equals().

int SiliconStudio.Paradox.Graphics.PresentationParameters.PreferredFullScreenOutputIndex

The output (monitor) index to use when switching to fullscreen mode. Doesn't have any effect when windowed mode is used.

Definition at line 70 of file PresentationParameters.cs.

PresentInterval SiliconStudio.Paradox.Graphics.PresentationParameters.PresentationInterval

Gets or sets the maximum rate at which the swap chain's back buffers can be presented to the front buffer.

Definition at line 60 of file PresentationParameters.cs.

Referenced by SiliconStudio.Paradox.Graphics.PresentationParameters.Equals().

Rational SiliconStudio.Paradox.Graphics.PresentationParameters.RefreshRate

A structure describing the refresh rate in hertz

Definition at line 65 of file PresentationParameters.cs.

Referenced by SiliconStudio.Paradox.Graphics.PresentationParameters.Equals().


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