RAII wrapper for a raw SDL_Joystick device. More...

#include <mxvk/include/mxvk/mxvk_controller.hpp>

Public Member Functions
void	close ()
	Close the joystick handle if open.
Sint16	getAxis (int axis) const
	Read the current axis value.
bool	getButton (int button) const
	Test whether a button is currently pressed.
Uint8	getHat (int hat) const
	Read the position of a POV hat.
std::optional< SDL_Joystick * >	handle () const
	Return the underlying SDL_Joystick handle as an optional.
int	joystickIndex () const
	Return the device index this joystick was opened with.
std::string	name () const
	Return the joystick's name as reported by SDL.
int	numAxes () const
int	numButtons () const
int	numHats () const
bool	open (int index)
	Open the joystick at the given device index.
VK_Joystick &	operator= (const VK_Joystick &)=delete
VK_Joystick &	operator= (VK_Joystick &&)=delete
SDL_Joystick *	unwrap () const
	Unwrap the SDL_Joystick pointer, asserting it is open.
	VK_Joystick ()
	Default constructor — device not yet opened.
	VK_Joystick (const VK_Joystick &)=delete
	VK_Joystick (VK_Joystick &&)=delete
	~VK_Joystick () noexcept
	Destructor — closes the joystick if open.

Static Public Member Functions
static int	joysticks ()
	Return the number of connected joysticks.

Protected Attributes
int	deviceIndex = -1
	Open index in the current joystick list.
SDL_JoystickID	instanceId = 0
	Stable SDL joystick instance identifier.
SDL_Joystick *	stick = nullptr
	Underlying SDL joystick handle.

Detailed Description

RAII wrapper for a raw SDL_Joystick device.

Opens an SDL joystick by index and provides axis, hat, and button readback. The handle is automatically closed on destruction.

Definition at line 21 of file mxvk_controller.hpp.

Constructor & Destructor Documentation

◆ VK_Joystick() [1/3]

mxvk::VK_Joystick::VK_Joystick ( )

default

Default constructor — device not yet opened.

◆ ~VK_Joystick()

mxvk::VK_Joystick::~VK_Joystick ( )

noexcept

Destructor — closes the joystick if open.

Definition at line 16 of file mxvk_controller.cpp.

16{ close(); }

mxvk::VK_Joystick::close

void close()

Close the joystick handle if open.

Definition mxvk_controller.cpp:63

◆ VK_Joystick() [2/3]

mxvk::VK_Joystick::VK_Joystick ( const VK_Joystick & )

delete

◆ VK_Joystick() [3/3]

mxvk::VK_Joystick::VK_Joystick ( VK_Joystick && )

delete

Member Function Documentation

◆ close()

void mxvk::VK_Joystick::close ( )

Close the joystick handle if open.

Definition at line 63 of file mxvk_controller.cpp.

                            {
        if (stick != nullptr) {
            SDL_CloseJoystick(stick);
        }
 
        stick = nullptr;
        deviceIndex = -1;
        instanceId = 0;
    }

◆ getAxis()

Sint16 mxvk::VK_Joystick::getAxis ( int axis ) const

nodiscard

Read the current axis value.

Parameters

axis	Axis index.

Returns: Axis value in the range [-32768, 32767].

Definition at line 103 of file mxvk_controller.cpp.

                                                    {
        if (stick == nullptr) {
            return 0;
        }
        return SDL_GetJoystickAxis(stick, axis);
    }

◆ getButton()

bool mxvk::VK_Joystick::getButton ( int button ) const

nodiscard

Test whether a button is currently pressed.

Parameters

button Button index.

Returns: true if pressed.

Definition at line 89 of file mxvk_controller.cpp.

                                                      {
        if (stick == nullptr) {
            return false;
        }
        return SDL_GetJoystickButton(stick, button);
    }

◆ getHat()

Uint8 mxvk::VK_Joystick::getHat ( int hat ) const

nodiscard

Read the position of a POV hat.

Parameters

hat	Hat index.

Returns: SDL hat position bitmask.

Definition at line 96 of file mxvk_controller.cpp.

                                                 {
        if (stick == nullptr) {
            return 0;
        }
        return SDL_GetJoystickHat(stick, hat);
    }

◆ handle()

std::optional< SDL_Joystick * > mxvk::VK_Joystick::handle ( ) const

nodiscard

Return the underlying SDL_Joystick handle as an optional.

Returns: std::optional containing the handle, or std::nullopt.

Definition at line 73 of file mxvk_controller.cpp.

                                                          {
        if (stick != nullptr) {
            return stick;
        }
        return std::nullopt;
    }

◆ joystickIndex()

int mxvk::VK_Joystick::joystickIndex ( ) const

Return the device index this joystick was opened with.

Returns: Device index.

Definition at line 87 of file mxvk_controller.cpp.

87{ return deviceIndex; }

◆ joysticks()

int mxvk::VK_Joystick::joysticks ( )

static

Return the number of connected joysticks.

Returns: SDL_NumJoysticks() result.

Definition at line 18 of file mxvk_controller.cpp.

                               {
        int count = 0;
        SDL_JoystickID *ids = SDL_GetJoysticks(&count);
        if (ids != nullptr) {
            SDL_free(ids);
        }
        return count;
    }

◆ name()

std::string mxvk::VK_Joystick::name ( ) const

Return the joystick's name as reported by SDL.

Returns: Device name string.

Definition at line 53 of file mxvk_controller.cpp.

                                      {
        if (stick != nullptr) {
            const char *device_name = SDL_GetJoystickName(stick);
            if (device_name != nullptr) {
                return device_name;
            }
        }
        return "Joystick Not Opened.";
    }

◆ numAxes()

int mxvk::VK_Joystick::numAxes ( ) const

nodiscard

Returns: Number of axes on this joystick.

Definition at line 126 of file mxvk_controller.cpp.

                                   {
        if (stick == nullptr) {
            return 0;
        }
        const int count = SDL_GetNumJoystickAxes(stick);
        return count < 0 ? 0 : count;
    }

◆ numButtons()

int mxvk::VK_Joystick::numButtons ( ) const

nodiscard

Returns: Number of buttons on this joystick.

Definition at line 110 of file mxvk_controller.cpp.

                                      {
        if (stick == nullptr) {
            return 0;
        }
        const int count = SDL_GetNumJoystickButtons(stick);
        return count < 0 ? 0 : count;
    }

◆ numHats()

int mxvk::VK_Joystick::numHats ( ) const

nodiscard

Returns: Number of hats on this joystick.

Definition at line 118 of file mxvk_controller.cpp.

                                   {
        if (stick == nullptr) {
            return 0;
        }
        const int count = SDL_GetNumJoystickHats(stick);
        return count < 0 ? 0 : count;
    }

◆ open()

bool mxvk::VK_Joystick::open ( int index )

Open the joystick at the given device index.

Parameters

index SDL joystick index (0-based) within the current device list.

Returns: true on success.

Definition at line 27 of file mxvk_controller.cpp.

                                          {
        close();
 
        int count = 0;
        SDL_JoystickID *ids = SDL_GetJoysticks(&count);
        if (ids == nullptr || index < 0 || index >= count) {
            if (ids != nullptr) {
                SDL_free(ids);
            }
            return false;
        }
 
        const SDL_JoystickID openedInstanceId = ids[index];
        SDL_free(ids);
 
        stick = SDL_OpenJoystick(openedInstanceId);
        if (stick == nullptr) {
            return false;
        }
 
        deviceIndex = index;
        instanceId = openedInstanceId;
        SDL_SetJoystickEventsEnabled(true);
        return true;
    }

◆ operator=() [1/2]

VK_Joystick & mxvk::VK_Joystick::operator= ( const VK_Joystick & )

delete

◆ operator=() [2/2]

VK_Joystick & mxvk::VK_Joystick::operator= ( VK_Joystick && )

delete

◆ unwrap()

SDL_Joystick * mxvk::VK_Joystick::unwrap ( ) const

Unwrap the SDL_Joystick pointer, asserting it is open.

Returns: Raw SDL_Joystick pointer.

Definition at line 80 of file mxvk_controller.cpp.

                                            {
        if (stick != nullptr) {
            return stick;
        }
        throw mxvk::Exception("Invalid joystick handle");
    }

Member Data Documentation

◆ deviceIndex

int mxvk::VK_Joystick::deviceIndex = -1

protected

Open index in the current joystick list.

Definition at line 103 of file mxvk_controller.hpp.

◆ instanceId

SDL_JoystickID mxvk::VK_Joystick::instanceId = 0

protected

Stable SDL joystick instance identifier.

Definition at line 104 of file mxvk_controller.hpp.

◆ stick

SDL_Joystick* mxvk::VK_Joystick::stick = nullptr

protected

Underlying SDL joystick handle.

Definition at line 102 of file mxvk_controller.hpp.

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

mxvk/include/mxvk/mxvk_controller.hpp
mxvk/src/mxvk_controller.cpp

MXVK Vulkan Framework 0.35.0 C++20 Vulkan rendering framework for practical 2D and 3D application development with SDL3.

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VK_Joystick() [1/3]

◆ ~VK_Joystick()

◆ VK_Joystick() [2/3]

◆ VK_Joystick() [3/3]

Member Function Documentation

◆ close()

◆ getAxis()

◆ getButton()

◆ getHat()

◆ handle()

◆ joystickIndex()

◆ joysticks()

◆ name()

◆ numAxes()

◆ numButtons()

◆ numHats()

◆ open()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ unwrap()

Member Data Documentation

◆ deviceIndex

◆ instanceId

◆ stick