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.
AzFramework::InputChannel::Snapshot Struct Reference

Snapshot of an input channel that can be constructed, copied, and stored independently. More...

#include <InputChannel.h>

Inherited by AzFramework::InputMapping::EmptySnapshot.

Public Member Functions

 Snapshot (const InputChannel &inputChannel)
 
 Snapshot (const InputChannelId &channelId, const InputDeviceId &deviceId, State state)
 
 Snapshot (const InputChannelId &channelId, const InputDeviceId &deviceId, State state, float value, float delta)
 

Public Attributes

InputChannelId m_channelId
 The channel id of the input channel.
 
InputDeviceId m_deviceId
 The device id of the input channel.
 
State m_state
 The state of the input channel.
 
float m_value
 The value of the input channel.
 
float m_delta
 The delta of the input channel.
 
LocalUserId m_localUserId
 The local user id assigned to the input device.
 

Detailed Description

Snapshot of an input channel that can be constructed, copied, and stored independently.

Constructor & Destructor Documentation

◆ Snapshot() [1/3]

AzFramework::InputChannel::Snapshot::Snapshot ( const InputChannel inputChannel)

Constructor

Parameters
[in]inputChannelThe input channel used to initialize the snapshot

◆ Snapshot() [2/3]

AzFramework::InputChannel::Snapshot::Snapshot ( const InputChannelId channelId,
const InputDeviceId deviceId,
State  state 
)

Constructor

Parameters
[in]channelIdThe channel id used to initialize the snapshot
[in]deviceIdThe device id used to initialize the snapshot
[in]stateThe state used to initialize the snapshot

◆ Snapshot() [3/3]

AzFramework::InputChannel::Snapshot::Snapshot ( const InputChannelId channelId,
const InputDeviceId deviceId,
State  state,
float  value,
float  delta 
)

Constructor

Parameters
[in]channelIdThe channel id used to initialize the snapshot
[in]deviceIdThe device id used to initialize the snapshot
[in]stateThe state used to initialize the snapshot
[in]valueThe value used to initialize the snapshot
[in]deltaThe delta used to initialize the snapshot

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