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

# GetShapeEqCompInternalSaturate

> GetShapeEqCompInternalSaturate

# GetShapeEqCompInternalSaturate

Gets the internal saturation flag.

## Syntax

```cpp theme={null}
bool GetShapeEqCompInternalSaturate(  
         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: bool

The internal saturation flag. True if saturated.

## Remarks

In a title audio engine, managing headroom can be very difficult. For this reason, each Scalable Hardware Audio Processing Engine (SHAPE) block maintains the state associated with signal overhead and gain. Each block other than the Sample Rate Convertor (SRC) maintains a flag that indicates whether internal saturation occurred during processing.

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)\
[GetShapeEqCompMixBufferPeakMagnitude](/reference/audio/shapeeqcompcontext/functions/getshapeeqcompmixbufferpeakmagnitude)\
[ShapeEqCompContext](/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members)


## Related topics

- [ShapeEqCompContext](/reference/audio/shapeeqcompcontext/shapeeqcompcontext_members.md)
- [GetShapeSrcInternalSaturate](/reference/audio/shapesrccontext/functions/getshapesrcinternalsaturate.md)
- [GetShapeFiltVolInternalSaturate](/reference/audio/shapefiltvolcontext/functions/getshapefiltvolinternalsaturate.md)
- [GetShapeEqCompSidechainMode](/reference/audio/shapeeqcompcontext/functions/getshapeeqcompsidechainmode.md)
- [GetShapeEqCompGain](/reference/audio/shapeeqcompcontext/functions/getshapeeqcompgain.md)