Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
AzFramework::InputChannelEventFilter Class Referenceabstract

#include <InputChannelEventFilter.h>

Inherited by AzFramework::InputChannelEventFilterExclusionList, and AzFramework::InputChannelEventFilterInclusionList.

Public Member Functions

 InputChannelEventFilter ()=default
 Default constructor.
 
 AZ_DEFAULT_COPY (InputChannelEventFilter)
 
virtual ~InputChannelEventFilter ()=default
 Default destructor.
 
virtual bool DoesPassFilter (const InputChannel &inputChannel) const =0
 

Static Public Attributes

static const AZ::Crc32 AnyChannelNameCrc32
 Wildcard representing any input channel name.
 
static const AZ::Crc32 AnyDeviceNameCrc32
 Wildcard representing any input device name.
 

Detailed Description

Class that filters input events by channel name, device name, local user id, or any combination of the three.

Member Function Documentation

◆ DoesPassFilter()

virtual bool AzFramework::InputChannelEventFilter::DoesPassFilter ( const InputChannel &  inputChannel) const
pure virtual

Check whether an input channel should pass through the filter

Parameters
[in]inputChannelThe input channel to be filtered
Returns
True if the input channel passes the filter, false otherwise

Implemented in AzFramework::InputChannelEventFilterInclusionList, and AzFramework::InputChannelEventFilterExclusionList.

The documentation for this class was generated from the following file: