GetShapeFiltVolInputHeadroom
Gets the input headroom.Syntax
Parameters
context _In_Type: SHAPE_FILTVOL_CONTEXT* Pointer to a SHAPE_FILTVOL_CONTEXT object.
Return value
Type: SHAPE_FILTER_HEADROOM A member of the SHAPE_FILTER_HEADROOM enumeration.Remarks
The state variable filter, by its nature, can create resonances causing intermediate values to exceed 1.0 (or -1.0). To mitigate the issues created by intermediate value saturation, the FLTVOL block has a programmable amount of headroom scaling, which is applied to the incoming signal and then compensated for upon output. 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 consolesSee also
SetShapeFiltVolInputHeadroomShapeFiltVolContext