controllerbridge.h File Reference

#include <stdint.h>
#include "ship/Api.h"
#include <memory>

Include dependency graph for controllerbridge.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	Ship
	Core namespace for the libultraship engine framework.

Functions
void	ControllerSetControlDeck (std::shared_ptr< Ship::ControlDeck > controlDeck)
std::shared_ptr< Ship::ControlDeck >	ControllerGetControlDeck ()
API_EXPORT void	ControllerBlockGameInput (uint16_t inputBlockId)
	Prevents controller gamepad input from being processed by the game.
API_EXPORT void	ControllerUnblockGameInput (uint16_t inputBlockId)
	Releases a previously established game input block.

Function Documentation

ControllerBlockGameInput()

API_EXPORT void ControllerBlockGameInput

(

uint16_t

inputBlockId

)

Prevents controller gamepad input from being processed by the game.

Multiple callers can independently block input; each must supply a unique inputBlockId and must call ControllerUnblockGameInput() with the same ID to release its block.

Parameters

inputBlockId

Caller-chosen identifier that distinguishes this blocker.

ControllerGetControlDeck()

std::shared_ptr< Ship::ControlDeck > ControllerGetControlDeck

(

)

ControllerSetControlDeck()

void ControllerSetControlDeck

(

std::shared_ptr< Ship::ControlDeck >

controlDeck

)

ControllerUnblockGameInput()

API_EXPORT void ControllerUnblockGameInput

(

uint16_t

inputBlockId

)

Releases a previously established game input block.

Input is only fully unblocked once all outstanding blockers have called this function.

Parameters

inputBlockId

The same ID passed to ControllerBlockGameInput().