Edit

Share via

D3D12_VIDEO_ENCODER_OUTPUT_METADATA structure (d3d12video.h)

  • Article

Represents metadata about an ID3D12VideoEncodeCommandList2::EncodeFrame operation.

Syntax

typedef struct D3D12_VIDEO_ENCODER_OUTPUT_METADATA {
  UINT64                                         EncodeErrorFlags;
  D3D12_VIDEO_ENCODER_OUTPUT_METADATA_STATISTICS EncodeStats;
  UINT64                                         EncodedBitstreamWrittenBytesCount;
  UINT64                                         WrittenSubregionsCount;
} D3D12_VIDEO_ENCODER_OUTPUT_METADATA;

Members

EncodeErrorFlags

A UINT64 representing a bitwise OR combination of values from the D3D12_VIDEO_ENCODER_ENCODE_ERROR_FLAG enumeration specifying information about the encode execution status.

EncodeStats

A D3D12_VIDEO_ENCODER_OUTPUT_METADATA_STATISTICS representing statistics for an EncodeFrame operation.

EncodedBitstreamWrittenBytesCount

Output field that receives a UINT64 indicating how many bytes were into D3D12_VIDEO_ENCODER_COMPRESSED_BITSTREAM.pBuffer plus the value of D3D12_VIDEO_ENCODER_COMPRESSED_BITSTREAM.FrameStartOffset.

WrittenSubregionsCount

Output field that receives a UINT64 indicating the number of subregions used to encode the current frame.

This value is coherent with the settings specified in D3D12_VIDEO_ENCODER_SEQUENCE_CONTROL_DESC.pFrameSubregionsLayoutData. If a number of subregions was specified, WrittenSubregionsCount should match that value. If another mode was used, this field is how the driver reports the final number of subregions. If the output is a full frame, then there is only 1 subregion.

Remarks

D3D12_VIDEO_ENCODER_OUTPUT_METADATA and its child structures are all aligned to a 64-bit access boundary for use with SetPredication.

Requirements

Requirement Value
Minimum supported client Windows Build 22000
Minimum supported server Windows Build 22000
Header d3d12video.h