Skip to main content

​
GetShapeFiltVolInternalSaturate

Gets the internal saturation flag.

​
Syntax

​
Parameters

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

​
Return value

Type: bool The internal saturation flag. True if saturated.

​
Remarks

The internal saturation flag indicates whether saturation occurred in the State Variable filter during processing. To specify headroom for internally created resonances and overflow, use the SetShapeFiltVolInputHeadroom function. For more information, see the Filter/volume block (FLTVOL) section of 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

ShapeFiltVolContextGetShapeSrcInternalSaturateGetShapeEqCompInternalSaturateGetShapeFiltVolQGetShapeFiltVolDelay1