Click or drag to resize
Ab4d.SharpEngine logo

OverlaySurfaceHost Class

OverlayHost is a control that is used to show the 3D scene when the OverlayTexture is used for the PresentationType property. The control is derived from System.Windows.Interop.HwndHost and provides a windows handle based area that can be used to display the 3D scene with using the Vulkan SwapChain. The area occupied with OverlayHost cannot be used by any other WPF element (this is possible when using SharedTexture PresentationType).
Inheritance Hierarchy
SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.Windows.MediaVisual
        System.WindowsUIElement
          System.WindowsFrameworkElement
            System.Windows.InteropHwndHost
              Ab4d.SharpEngine.Wpf.ControlsOverlaySurfaceHost

Namespace: Ab4d.SharpEngine.Wpf.Controls
Assembly: Ab4d.SharpEngine.Wpf (in Ab4d.SharpEngine.Wpf.dll) Version: 3.2.9386+3a404a3e1ebfa4efd231da7fe6f10dfb23b95dc4
Syntax
C#
Copy
public class OverlaySurfaceHost : HwndHost

The OverlaySurfaceHost type exposes the following members.

Constructors
 NameDescription
Public methodOverlaySurfaceHost Constructor
Top
Properties
 NameDescription
Public propertyClientWindowSize Gets the IntSize (width and height as int) of the created window.
Public propertyIsInitiallyPainted Gets a boolean that specifies if the created window is initially painted
Public propertyVulkanSurface 
Top
Methods
 NameDescription
Protected methodBuildWindowCore BuildWindowCore
Protected methodDestroyWindowCore DestroyWindowCore
Protected methodDispose Dispose
(Overrides HwndHostDispose(Boolean))
Public methodGetHWnd Returns a handle to used window.
Protected methodOnPainting OnPainting
Protected methodOnRender OnRender
(Overrides UIElementOnRender(DrawingContext))
Protected methodOnSizeChanging OnSizeChanging
Protected methodWndProc WndProc
(Overrides HwndHostWndProc(IntPtr, Int32, IntPtr, IntPtr, Boolean))
Top
Events
 NameDescription
Public eventPainting Called when WM_PAINT message is passed to OverlayHost WndProc
Public eventSizeChanging Called when WM_SIZE message is passed to OverlayHost WndProc
Public eventSurfaceCreated Called when VulkanSurface objects is created and a valid window handle is available to create the surface.
Top
Fields
 NameDescription
Public fieldStatic memberRenderAsManyFramesAsPossible Gets or sets a static Boolean that specifies if rendering is not bound to WPF's frame rate but is rendering as many frames as possible (when set to true).
Top
See Also