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

This class is a frontend to SwapChain and SwapChain1. More...

Inheritance diagram for SiliconStudio.Paradox.Graphics.GraphicsPresenter:
SiliconStudio.Core.ComponentBase SiliconStudio.Core.IComponent SiliconStudio.Core.ICollectorHolder SiliconStudio.Core.IReferencable SiliconStudio.Core.IReferencable SiliconStudio.Paradox.Graphics.RenderTargetGraphicsPresenter

Public Member Functions

abstract void Present ()
 Presents the Backbuffer to the screen. More...
 
void Resize (int width, int height, PixelFormat format)
 Resizes the current presenter, by resizing the back buffer and the depth stencil buffer. More...
 
virtual void OnDestroyed ()
 Called when [destroyed]. More...
 
virtual void OnRecreated ()
 Called when [recreated]. More...
 
- Public Member Functions inherited from SiliconStudio.Core.ComponentBase
void Dispose ()
 
override string ToString ()
 

Protected Member Functions

 GraphicsPresenter (GraphicsDevice device, PresentationParameters presentationParameters)
 Initializes a new instance of the GraphicsPresenter class. More...
 
abstract void ResizeBackBuffer (int width, int height, PixelFormat format)
 
abstract void ResizeDepthStencilBuffer (int width, int height, PixelFormat format)
 
void ReleaseCurrentDepthStencilBuffer ()
 
virtual void CreateDepthStencilBuffer ()
 Creates the depth stencil buffer. More...
 
- Protected Member Functions inherited from SiliconStudio.Core.ComponentBase
 ComponentBase ()
 Initializes a new instance of the ComponentBase class. More...
 
 ComponentBase (string name)
 Initializes a new instance of the ComponentBase class. More...
 
virtual void OnNameChanged ()
 Called when Name property was changed. More...
 
virtual void Destroy ()
 Disposes of object resources. More...
 

Properties

GraphicsDevice GraphicsDevice [get, set]
 Gets the graphics device. More...
 
PresentationParameters Description [get, set]
 Gets the description of this presenter. More...
 
Viewport DefaultViewport [get, set]
 Default viewport that covers the whole presenter surface. More...
 
abstract RenderTarget BackBuffer [get]
 Gets the default back buffer for this presenter. More...
 
DepthStencilBuffer DepthStencilBuffer [get, set]
 Gets the default depth stencil buffer for this presenter. More...
 
abstract object NativePresenter [get]
 Gets the underlying native presenter (can be a SharpDX.DXGI.SwapChain or SharpDX.DXGI.SwapChain1 or null, depending on the platform). More...
 
abstract bool IsFullScreen [get, set]
 Gets or sets fullscreen mode for this presenter. More...
 
PresentInterval PresentInterval [get, set]
 Gets or sets the PresentInterval. Default is to wait for one vertical blanking. More...
 
- Properties inherited from SiliconStudio.Core.ComponentBase
long Id [get, set]
 
string Name [get, set]
 Gets or sets the name of this component. More...
 
bool IsDisposed [get, set]
 Has the component been disposed or not yet. More...
 
- Properties inherited from SiliconStudio.Core.IComponent
long Id [get]
 Gets the id of this component. More...
 
string Name [get]
 Gets the name of this component. More...
 
- Properties inherited from SiliconStudio.Core.IReferencable
int ReferenceCount [get]
 Gets the reference count of this instance. More...
 
- Properties inherited from SiliconStudio.Core.ICollectorHolder
ObjectCollector Collector [get]
 Gets the collector. More...
 

Additional Inherited Members

- Public Attributes inherited from SiliconStudio.Core.ComponentBase
PropertyContainer Tags
 Gets the attached properties to this component. More...
 

Detailed Description

This class is a frontend to SwapChain and SwapChain1.

In order to create a new GraphicsPresenter, a GraphicsDevice should have been initialized first.

Definition at line 36 of file GraphicsPresenter.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Graphics.GraphicsPresenter.GraphicsPresenter ( GraphicsDevice  device,
PresentationParameters  presentationParameters 
)
protected

Initializes a new instance of the GraphicsPresenter class.

Parameters
deviceThe device.
presentationParameters

Definition at line 45 of file GraphicsPresenter.cs.

Member Function Documentation

virtual void SiliconStudio.Paradox.Graphics.GraphicsPresenter.CreateDepthStencilBuffer ( )
protectedvirtual

Creates the depth stencil buffer.

Definition at line 168 of file GraphicsPresenter.cs.

virtual void SiliconStudio.Paradox.Graphics.GraphicsPresenter.OnDestroyed ( )
virtual

Called when [destroyed].

Definition at line 154 of file GraphicsPresenter.cs.

virtual void SiliconStudio.Paradox.Graphics.GraphicsPresenter.OnRecreated ( )
virtual

Called when [recreated].

Definition at line 161 of file GraphicsPresenter.cs.

abstract void SiliconStudio.Paradox.Graphics.GraphicsPresenter.Present ( )
pure virtual

Presents the Backbuffer to the screen.

Implemented in SiliconStudio.Paradox.Graphics.RenderTargetGraphicsPresenter.

void SiliconStudio.Paradox.Graphics.GraphicsPresenter.ReleaseCurrentDepthStencilBuffer ( )
protected

Definition at line 142 of file GraphicsPresenter.cs.

void SiliconStudio.Paradox.Graphics.GraphicsPresenter.Resize ( int  width,
int  height,
PixelFormat  format 
)

Resizes the current presenter, by resizing the back buffer and the depth stencil buffer.

Parameters
width
height

Definition at line 126 of file GraphicsPresenter.cs.

References DirectX.format.

abstract void SiliconStudio.Paradox.Graphics.GraphicsPresenter.ResizeBackBuffer ( int  width,
int  height,
PixelFormat  format 
)
protectedpure virtual
abstract void SiliconStudio.Paradox.Graphics.GraphicsPresenter.ResizeDepthStencilBuffer ( int  width,
int  height,
PixelFormat  format 
)
protectedpure virtual

Property Documentation

abstract RenderTarget SiliconStudio.Paradox.Graphics.GraphicsPresenter.BackBuffer
get

Gets the default back buffer for this presenter.

Definition at line 75 of file GraphicsPresenter.cs.

Viewport SiliconStudio.Paradox.Graphics.GraphicsPresenter.DefaultViewport
getset

Default viewport that covers the whole presenter surface.

Definition at line 70 of file GraphicsPresenter.cs.

DepthStencilBuffer SiliconStudio.Paradox.Graphics.GraphicsPresenter.DepthStencilBuffer
getset

Gets the default depth stencil buffer for this presenter.

Definition at line 81 of file GraphicsPresenter.cs.

PresentationParameters SiliconStudio.Paradox.Graphics.GraphicsPresenter.Description
getset

Gets the description of this presenter.

Definition at line 65 of file GraphicsPresenter.cs.

GraphicsDevice SiliconStudio.Paradox.Graphics.GraphicsPresenter.GraphicsDevice
getset

Gets the graphics device.

The graphics device.

Definition at line 60 of file GraphicsPresenter.cs.

abstract bool SiliconStudio.Paradox.Graphics.GraphicsPresenter.IsFullScreen
getset

Gets or sets fullscreen mode for this presenter.

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

This method is only valid on Windows Desktop and has no effect on Windows Metro.

Definition at line 104 of file GraphicsPresenter.cs.

abstract object SiliconStudio.Paradox.Graphics.GraphicsPresenter.NativePresenter
get

Gets the underlying native presenter (can be a SharpDX.DXGI.SwapChain or SharpDX.DXGI.SwapChain1 or null, depending on the platform).

The native presenter.

Definition at line 97 of file GraphicsPresenter.cs.

PresentInterval SiliconStudio.Paradox.Graphics.GraphicsPresenter.PresentInterval
getset

Gets or sets the PresentInterval. Default is to wait for one vertical blanking.

The present interval.

Definition at line 111 of file GraphicsPresenter.cs.


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