> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GetShapeEqCompMixBufferPeakMagnitude

> GetShapeEqCompMixBufferPeakMagnitude

# GetShapeEqCompMixBufferPeakMagnitude

Gets the peak magnitude of the output mix buffer.

## Syntax

```cpp theme={null}
float GetShapeEqCompMixBufferPeakMagnitude(  
         const SHAPE_EQCOMP_CONTEXT* context  
)  
```

### Parameters

*context*   \_In\_\
Type: [SHAPE\_EQCOMP\_CONTEXT\*](/reference/audio/shapeeqcompcontext/structs/shape_eqcomp_context)

Pointer to a `SHAPE_EQCOMP_CONTEXT` object.

### Return value

Type: float

The peak magnitude.

## Remarks

In addition to monitoring the peak magnitude of each individual hardware block, the peak magnitude of the mix buffers is also maintained. When the output of a hardware block is added to a mix buffer, the peak magnitude is calculated in the same manner: by counting the leading zeros. Each hardware block state maintains an additional pair of four-bit peak-magnitude values. These values represent the peak magnitude of the mix buffer after the output of the hardware block has been accumulated into the mix buffer. One four-bit number represents the ongoing, persistent peak magnitude; the other is updated for every audio frame. The peak-magnitude values are saved in the context of the Scalable Hardware Audio Processing Engine (SHAPE) blocks, even though what's being represented is the mix buffer state.

For more information, see [Overflow, magnitude, and saturation](/build/console-features/audio/overviews/shape-overview#ID4ELAAC) in [Overview of SHAPE](/build/console-features/audio/overviews/shape-overview).

## Requirements

**Header:** shapeeqcompcontext.h

**Supported platforms:** XBOX One family consoles and XBOX Series consoles

## See also

[GetShapeEqCompPeakMagnitude](/reference/audio/shapeeqcompcontext/functions/getshapeeqcomppeakmagnitude)\
[ShapeEqCompContext](/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members)


## Related topics

- [GetShapeEqCompPeakMagnitude](/reference/audio/shapeeqcompcontext/functions/getshapeeqcomppeakmagnitude.md)
- [GetShapeEqCompInternalSaturate](/reference/audio/shapeeqcompcontext/functions/getshapeeqcompinternalsaturate.md)
- [ShapeEqCompContext](/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members.md)
- [GetShapeDmaMixBufferPeakMagnitude](/reference/audio/shapedmacontext/functions/getshapedmamixbufferpeakmagnitude.md)
- [GetShapeFiltVolMixBufferPeakMagnitude](/reference/audio/shapefiltvolcontext/functions/getshapefiltvolmixbufferpeakmagnitude.md)
