Direct3D11CaptureFramePool Class

Reference

Definition

Namespace:: Windows.Graphics.Capture

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Stores frames captured by the application.

public ref class Direct3D11CaptureFramePool sealed : IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 393216)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Direct3D11CaptureFramePool final : IClosable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 393216)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class Direct3D11CaptureFramePool : System.IDisposable

Public NotInheritable Class Direct3D11CaptureFramePool
Implements IDisposable

Inheritance: Object Platform::Object IInspectable Direct3D11CaptureFramePool

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements: IClosable IDisposable

Windows requirements

Device family	Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v6.0)

Remarks

Version history

Windows version	SDK version	Value added
1809	17763	CreateFreeThreaded

Properties

DispatcherQueue

The DispatcherQueue for the frame pool.

Methods

Close()	Disposes of the capture frame pool and releases its resources.
Create(IDirect3DDevice, DirectXPixelFormat, Int32, SizeInt32)	Creates a frame pool.
CreateCaptureSession(GraphicsCaptureItem)	Creates a capture session based on the given capture item and frame pool.
CreateFreeThreaded(IDirect3DDevice, DirectXPixelFormat, Int32, SizeInt32)	Creates a frame pool where the dependency on the DispatcherQueue is removed and the FrameArrived event is raised on the frame pool's internal worker thread.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Recreate(IDirect3DDevice, DirectXPixelFormat, Int32, SizeInt32)	Recreates the frame pool based on the given inputs.
TryGetNextFrame()	Tries to get the next captured frame from the frame pool.

Events

FrameArrived

An event raised when a captured frame is stored in the frame pool.

Applies to