Class ScreenCaptureD3D11SourceSettings

Direct3D 11 screen capture source settings.

Inheritance
object
ScreenCaptureD3D11SourceSettings
Implements
Inherited Members
Namespace: VisioForge.Core.Types.X.Sources
Assembly: VisioForge.Core.dll
Syntax
public class ScreenCaptureD3D11SourceSettings : IScreenCaptureSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoSourceSettings, IMediaBlockSettings

Constructors

ScreenCaptureD3D11SourceSettings()

Initializes a new instance of the ScreenCaptureD3D11SourceSettings class.

Declaration
public ScreenCaptureD3D11SourceSettings()

Properties

API

Gets or sets the API.

Declaration
public D3D11ScreenCaptureAPI API { get; set; }
Property Value
Type Description
D3D11ScreenCaptureAPI

The API.

CaptureCursor

Gets or sets a value indicating whether mouse cursor capture is enabled.

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

DXGIAdapter

Gets or sets the DXGI adapter index for creating device when WGC mode is selected. -1 for default adapter.

Declaration
public int DXGIAdapter { get; set; }
Property Value
Type Description
int

The DXGI adapter.

FrameRate

Gets or sets the frame rate.

Declaration
public VideoFrameRate FrameRate { get; set; }
Property Value
Type Description
VideoFrameRate

MonitorHandle

Gets or sets the HMONITOR handle of monitor to capture.

Declaration
public nint MonitorHandle { get; set; }
Property Value
Type Description
nint

MonitorIndex

Gets or sets the monitor ID. Enumeration started from 0. -1 for primary monitor.

Declaration
public int MonitorIndex { get; set; }
Property Value
Type Description
int

Rectangle

Gets or sets the rectangle to capture.

Declaration
public Rect Rectangle { get; set; }
Property Value
Type Description
Rect

ShowBorderLines

Gets or sets a value indicating whether to show border lines to capture area when WGC mode is selected (Windows 11 or newer is required).

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

true if to show border lines; otherwise, false.

WindowHandle

Gets or sets the window handle to capture (optional).

Declaration
public nint WindowHandle { get; set; }
Property Value
Type Description
nint

The window handle.

Methods

CreateBlock()

Creates the block.

Declaration
public MediaBlock CreateBlock()
Returns
Type Description
MediaBlock

MediaBlock.

GetSourceType()

Gets the type of the source.

Declaration
public ScreenCaptureSourceType GetSourceType()
Returns
Type Description
ScreenCaptureSourceType

ScreenCaptureSourceType.

IsWGCAvailable()

Determines whether is WGC available.

Declaration
public static bool IsWGCAvailable()
Returns
Type Description
bool

true if is WGC available; otherwise, false.

UpdateLiveSettings(int, int, bool)

Updates the live settings.

Declaration
public void UpdateLiveSettings(int x, int y, bool cursor)
Parameters
Type Name Description
int x

The x.
int y

The y.
bool cursor

if set to true show cursor.

Events

OnUpdated

Occurs when on updated.

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

Implements

IScreenCaptureSourceSettings
IVideoCaptureBaseVideoSourceSettings
IVideoSourceSettings
IMediaBlockSettings