Class Display

This class represent a display.

Inheritance
object
DisposableObject
Display
OpenXRDisplay
Inherited Members
Namespace: Evergine.Framework.Graphics
Assembly: Evergine.Framework.dll
Syntax
public class Display : DisposableObject

Constructors

Display(Surface, FrameBuffer)

Initializes a new instance of the Display class.

Declaration
public Display(Surface surface, FrameBuffer frameBuffer)
Parameters
Type Name Description
Surface surface

The surface instance.
FrameBuffer frameBuffer

FrameBuffer instance.

Display(Surface, SwapChain)

Initializes a new instance of the Display class.

Declaration
public Display(Surface surface, SwapChain swapChain)
Parameters
Type Name Description
Surface surface

The surface instance.
SwapChain swapChain

SwapChain instance.

Fields

FrameBuffer

The display framebuffer.

Declaration
public FrameBuffer FrameBuffer
Field Value
Type Description
FrameBuffer

Surface

The surface associated to this display.

Declaration
public readonly Surface Surface
Field Value
Type Description
Surface

SwapChain

The swapchain.

Declaration
public SwapChain SwapChain
Field Value
Type Description
SwapChain

isStereo

This is a stereo display.

Declaration
protected bool isStereo
Field Value
Type Description
bool

Properties

HasFocus

Gets a value indicating whether this display has focus.

Declaration
public bool HasFocus { get; }
Property Value
Type Description
bool

Height

Gets the display height.

Declaration
public uint Height { get; }
Property Value
Type Description
uint

IsStereo

Gets a value indicating whether this is a stereo display.

Declaration
public bool IsStereo { get; }
Property Value
Type Description
bool

IsVisible

Gets or sets a value indicating whether this display is visible.

Declaration
public virtual bool IsVisible { get; set; }
Property Value
Type Description
bool

KeyboardDispatcher

Gets the Keyboard dispatcher.

Declaration
public KeyboardDispatcher KeyboardDispatcher { get; }
Property Value
Type Description
KeyboardDispatcher

MouseDispatcher

Gets the Mouse dispatcher.

Declaration
public MouseDispatcher MouseDispatcher { get; }
Property Value
Type Description
MouseDispatcher

TouchDispatcher

Gets the Touch dispatcher.

Declaration
public PointerDispatcher TouchDispatcher { get; }
Property Value
Type Description
PointerDispatcher

Width

Gets the display width.

Declaration
public uint Width { get; }
Property Value
Type Description
uint

Methods

BeforePresent()

Method executed in a step before the present of the display.

Declaration
public virtual void BeforePresent()

Destroy()

Destroy all resources of this instance.

Declaration
protected override void Destroy()
Overrides

DispatchInputEvents()

Dispatch input events.

Declaration
public void DispatchInputEvents()

InitFrame()

Initialize the frame to rendering.

Declaration
public virtual void InitFrame()

Prepare()

Presents a rendered image to the user.

Declaration
public virtual void Prepare()

Present()

Presents a rendered image to the user.

Declaration
public virtual void Present()

UpdateFrameBuffer(FrameBuffer)

Update the framebuffer.

Declaration
public void UpdateFrameBuffer(FrameBuffer frameBuffer)
Parameters
Type Name Description
FrameBuffer frameBuffer

The framebuffer.

Events

DisplayDisposed

Event fired when display is disposed.

Declaration
public event EventHandler DisplayDisposed
Event Type
Type Description
EventHandler

DisplayFrameBufferChanged

Event fired when display framebuffer is changed.

Declaration
public event EventHandler<EventArgs> DisplayFrameBufferChanged
Event Type
Type Description
EventHandler<EventArgs>

DisplaySizeChanged

Event fired when the display size is changed.

Declaration
public event EventHandler<SizeEventArgs> DisplaySizeChanged
Event Type
Type Description
EventHandler<SizeEventArgs>

SurfaceInfoChanged

Events fired when the display surface is changed.

Declaration
public event EventHandler<SurfaceInfo> SurfaceInfoChanged
Event Type
Type Description
EventHandler<SurfaceInfo>

Extension Methods