InputState

Represents the entire input state for the duration of a processed frame

File location: framework/cauldron/framework/inc/core/inputmanager.h

Methods

Return type

Description

bool

GetKeyState (const KeyboardInputMappings inputID) const
Returns the key down state of the requested input mapping.

bool

GetKeyUpState (const KeyboardInputMappings inputID) const
Returns the key up state of the requested input mapping.

bool

GetMouseButtonState (const MouseButtonMappings inputID) const
Returns the button down state of the requested input mapping.

bool

GetMouseButtonUpState (const MouseButtonMappings inputID) const
Returns the button up state of the requested input mapping.

int64_t

GetMouseAxisDelta (const MouseAxisMappings inputID) const
Returns the axis value of the requested input mapping.

float

GetGamePadAxisState (const GamePadAxisMappings inputID) const
Returns axis value of the requested input mapping.

bool

GetGamePadButtonState (const GamePadButtonMappings inputID) const
Returns the button down state of the requested input mapping.

bool

GetGamePadButtonUpState (const GamePadButtonMappings inputID) const
Returns the button up state of the requested input mapping.

Detailed description

Represents the entire input state for the duration of a processed frame

Data fields

Type

Description

MouseState

Mouse
Represents the state of mouse input.

GamePadState

GamePad
Represents the state of gamepad input.

uint64_t

KeyboardState
Bitwise mapping of keyboard key down states for all monitored keys.

uint64_t

KeyboardUpState
Bitwise mapping of keyboard key up states for all monitored keys.

Methods

GetKeyState

Copied!

bool GetKeyState (const KeyboardInputMappings  inputID) const

Returns the key down state of the requested input mapping.


GetKeyUpState

Copied!

bool GetKeyUpState (const KeyboardInputMappings  inputID) const

Returns the key up state of the requested input mapping.


GetMouseButtonState

Copied!

bool GetMouseButtonState (const MouseButtonMappings  inputID) const

Returns the button down state of the requested input mapping.


GetMouseButtonUpState

Copied!

bool GetMouseButtonUpState (const MouseButtonMappings  inputID) const

Returns the button up state of the requested input mapping.


GetMouseAxisDelta

Copied!

int64_t GetMouseAxisDelta (const MouseAxisMappings  inputID) const

Returns the axis value of the requested input mapping.


GetGamePadAxisState

Copied!

float GetGamePadAxisState (const GamePadAxisMappings  inputID) const

Returns axis value of the requested input mapping.


GetGamePadButtonState

Copied!

bool GetGamePadButtonState (const GamePadButtonMappings  inputID) const

Returns the button down state of the requested input mapping.


GetGamePadButtonUpState

Copied!

bool GetGamePadButtonUpState (const GamePadButtonMappings  inputID) const

Returns the button up state of the requested input mapping.


Related pages

  • Visit the FidelityFX SDK product page for download links and more information.

Looking for more documentation on GPUOpen?

AMD GPUOpen software blogs

Our handy software release blogs will help you make good use of our tools, SDKs, and effects, as well as sharing the latest features with new releases.

GPUOpen Manuals

Don’t miss our manual documentation! And if slide decks are what you’re after, you’ll find 100+ of our finest presentations here.

AMD GPUOpen Performance Guides

The home of great performance and optimization advice for AMD RDNAâ„¢ 2 GPUs, AMD Ryzenâ„¢ CPUs, and so much more.

Getting started: AMD GPUOpen software

New or fairly new to AMD’s tools, libraries, and effects? This is the best place to get started on GPUOpen!

AMD GPUOpen Getting Started Development and Performance

Looking for tips on getting started with developing and/or optimizing your game, whether on AMD hardware or generally? We’ve got you covered!

AMD GPUOpen Technical blogs

Browse our technical blogs, and find valuable advice on developing with AMD hardware, ray tracing, Vulkan®, DirectX®, Unreal Engine, and lots more.

Find out more about our software!

AMD GPUOpen Effects - AMD FidelityFX technologies

Create wonder. No black boxes. Meet the AMD FidelityFX SDK!

AMD GPUOpen Samples

Browse all our useful samples. Perfect for when you’re needing to get started, want to integrate one of our libraries, and much more.

AMD GPUOpen developer SDKs

Discover what our SDK technologies can offer you. Query hardware or software, manage memory, create rendering applications or machine learning, and much more!

AMD GPUOpen Developer Tools

Analyze, Optimize, Profile, Benchmark. We provide you with the developer tools you need to make sure your game is the best it can be!