GetShapeFiltVolInternalSaturate

Gets the internal saturation flag.

Syntax

bool GetShapeFiltVolInternalSaturate(  
         const SHAPE_FILTVOL_CONTEXT* context  
)  

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

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

GetShapeFiltVolInternalSaturate

GetShapeFiltVolInternalSaturate

Syntax

Parameters

Return value

Remarks

Requirements

See also

​GetShapeFiltVolInternalSaturate

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

GetShapeFiltVolInternalSaturate

Syntax

Parameters

Return value

Remarks

Requirements

See also