Table of Contents

Class ScreenCaptureD3D11SourceSettings

Namespace
VisioForge.Core.Types.X.Sources
Assembly
VisioForge.Core.dll

Direct3D 11 screen capture source settings.

public class ScreenCaptureD3D11SourceSettings : IScreenCaptureSourceSettings, IVideoCaptureBaseVideoSourceSettings, IVideoSourceSettings, IMediaBlockSettings

Inheritance

Implements

Inherited Members

Constructors

ScreenCaptureD3D11SourceSettings()

Initializes a new instance of the VisioForge.Core.Types.X.Sources.ScreenCaptureD3D11SourceSettings class.

public ScreenCaptureD3D11SourceSettings()

Properties

API

Gets or sets the API.

public D3D11ScreenCaptureAPI API { get; set; }

Property Value

D3D11ScreenCaptureAPI

CaptureCursor

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

public bool CaptureCursor { get; set; }

Property Value

bool

DXGIAdapter

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

public int DXGIAdapter { get; set; }

Property Value

int

FrameRate

Gets or sets the frame rate.

public VideoFrameRate FrameRate { get; set; }

Property Value

VideoFrameRate

MonitorHandle

Gets or sets the HMONITOR handle of monitor to capture.

public nint MonitorHandle { get; set; }

Property Value

nint

MonitorIndex

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

public int MonitorIndex { get; set; }

Property Value

int

MouseHighlight

Gets or sets the mouse click highlight settings. When not null, mouse click positions are drawn as animated expanding circles on the captured screen video. Set to null to disable mouse click highlighting.

public MouseHighlightSettings MouseHighlight { get; set; }

Property Value

MouseHighlightSettings

Rectangle

Gets or sets the rectangle to capture.

public Rect Rectangle { get; set; }

Property Value

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).

public bool ShowBorderLines { get; set; }

Property Value

bool

WindowCaptureMode

Gets or sets the window capture mode.

public D3D11WindowCaptureMode WindowCaptureMode { get; set; }

Property Value

D3D11WindowCaptureMode

Remarks

This property determines how window capture is performed when using Windows Graphics Capture (WGC) API. Only applicable when API is set to WGC and WindowHandle is specified.

WindowHandle

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

public nint WindowHandle { get; set; }

Property Value

nint

Methods

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetSourceType()

Gets the type of the source.

public ScreenCaptureSourceType GetSourceType()

Returns

ScreenCaptureSourceType

ScreenCaptureSourceType.

IsWGCAvailable()

Determines whether is WGC available.

public static bool IsWGCAvailable()

Returns

bool

true if is WGC available; otherwise, false.

UpdateLiveSettings(int, int, bool)

Updates the live settings.

public void UpdateLiveSettings(int x, int y, bool cursor)

Parameters

x int

The x.

y int

The y.

cursor bool

if set to true show cursor.

OnUpdated

Occurs when on updated.

public event EventHandler<EventArgs> OnUpdated

Event Type

EventHandler<EventArgs>