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

# GetShapeFiltVolInputHeadroom

> GetShapeFiltVolInputHeadroom

# GetShapeFiltVolInputHeadroom

Gets the input headroom.

## Syntax

```cpp theme={null}
SHAPE_FILTER_HEADROOM GetShapeFiltVolInputHeadroom(  
         const SHAPE_FILTVOL_CONTEXT* context  
)  
```

### Parameters

*context*   \_In\_\
Type: [SHAPE\_FILTVOL\_CONTEXT](/reference/audio/shapefiltvolcontext/structs/shape_filtvol_context)\*

Pointer to a [SHAPE\_FILTVOL\_CONTEXT](/reference/audio/shapefiltvolcontext/structs/shape_filtvol_context) object.

### Return value

Type: SHAPE\_FILTER\_HEADROOM

A member of the [SHAPE\_FILTER\_HEADROOM](/reference/audio/shapefiltvolcontext/enums/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)](/build/console-features/audio/overviews/shape-overview#ID4EBH) section of [Overview of SHAPE](/build/console-features/audio/overviews/shape-overview).

## Requirements

**Header:** shapefiltvolcontext.h

**Supported platforms:** XBOX One family consoles and XBOX Series consoles

## See also

[SetShapeFiltVolInputHeadroom](/reference/audio/shapefiltvolcontext/functions/setshapefiltvolinputheadroom)\
[ShapeFiltVolContext](/reference/audio/shapefiltvolcontext/shapefiltvolcontext_members)


## Related topics

- [SetShapeFiltVolInputHeadroom](/reference/audio/shapefiltvolcontext/functions/setshapefiltvolinputheadroom.md)
- [SHAPE_FILTER_HEADROOM](/reference/audio/shapefiltvolcontext/enums/shape_filter_headroom.md)
- [ShapeFiltVolContext](/reference/audio/shapefiltvolcontext/shapefiltvolcontext_members.md)
- [GetShapeFiltVolInternalSaturate](/reference/audio/shapefiltvolcontext/functions/getshapefiltvolinternalsaturate.md)
- [GetShapeFiltVolQ](/reference/audio/shapefiltvolcontext/functions/getshapefiltvolq.md)