Skip to main content

​
GetShapeFiltVolPeakMagnitude

Gets the peak magnitude.

​
Syntax

​
Parameters

context   _In_
Type: SHAPE_FILTVOL_CONTEXT* Pointer to a SHAPE_FILTVOL_CONTEXT object.

​
Return value

Type: float The peak magnitude.

​
Remarks

Each hardware block maintains two four-bit numbers that represent the magnitude of the output of the hardware block. The magnitude is calculated by determining the peak output during the audio frame and by counting the leading zeros of the absolute value of the peak. One four-bit number is maintained with the persistent peak magnitude, and the other is reset by the hardware for every audio frame. For more information, see Overflow, magnitude, and saturation in Overview of SHAPE.

​
Requirements

Header: shapefiltvolcontext.h Supported platforms: XBOX One family consoles and XBOX Series consoles

​
See also

ShapeFiltVolContext
Last modified on August 20, 2026

Related topics

ShapeFiltVolContextGetShapeFiltVolMixBufferPeakMagnitudeGetShapeDmaPeakMagnitudeGetShapeEqCompPeakMagnitudeGetShapeDmaMixBufferPeakMagnitude