SetShapeFiltVolMode

Sets the mode of the state variable filter.

Syntax

HRESULT SetShapeFiltVolMode(  
         SHAPE_FILTVOL_CONTEXT* context,  
         SHAPE_FILTER_MODE ShapeFilterMode  
)  

Parameters

context _Inout_
Type: SHAPE_FILTVOL_CONTEXT* Pointer to a SHAPE_FILTVOL_CONTEXT object. ShapeFilterMode
Type: SHAPE_FILTER_MODE A member of the SHAPE_FILTER_MODE enumeration.

Return value

Type: HRESULT HRESULT success or error code.

Remarks

The Filter/Volume (FLTVOL) block is implemented as a Chamberlin filter. It provides three filtering modes (low-pass, band-pass, and high-pass) and a bypass mode. To get the current mode, use GetShapeFiltVolMode. The filtering behavior is designed to be identical to that in XAudio2. 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

SetShapeFiltVolMode

SetShapeFiltVolMode

Syntax

Parameters

Return value

Remarks

Requirements

See also

​SetShapeFiltVolMode

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

SetShapeFiltVolMode

Syntax

Parameters

Return value

Remarks

Requirements

See also