GetShapeEqCompInternalSaturate
Gets the internal saturation flag.Syntax
Parameters
context _In_Type: 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 in Overview of SHAPE.Requirements
Header: shapeeqcompcontext.h Supported platforms: XBOX One family consoles and XBOX Series consolesSee also
GetShapeEqCompPeakMagnitudeGetShapeEqCompMixBufferPeakMagnitude
ShapeEqCompContext