mxvk_wrap.input.Joystick Class Reference

Public Member Functions
None	__init__ (self, int index=0)
	An opened SDL joystick.
int	axis (self, int index)
bool	button (self, int index)
None	close (self)
int	count (cls)

Public Attributes
	native = mxvk.Joystick()
	Open joystick index.

Detailed Description

Definition at line 7 of file input.py.

Constructor & Destructor Documentation

__init__()

None mxvk_wrap.input.Joystick.__init__	(		self,
		int	index = 0 )

An opened SDL joystick.

Definition at line 10 of file input.py.

    def __init__(self, index: int = 0) -> None:
        ## @brief Open joystick @p index.
        self.native = mxvk.Joystick()
        self.native.open(index)
 

Member Function Documentation

axis()

int mxvk_wrap.input.Joystick.axis	(		self,
		int	index )

Definition at line 24 of file input.py.

    def axis(self, index: int) -> int:
        ## @brief Return the signed raw value for axis @p index.
        return self.native.axis(index)
 

button()

bool mxvk_wrap.input.Joystick.button	(		self,
		int	index )

Definition at line 20 of file input.py.

    def button(self, index: int) -> bool:
        ## @brief Return whether button @p index is pressed.
        return self.native.button(index)
 

close()

None mxvk_wrap.input.Joystick.close

(

self

)

Definition at line 28 of file input.py.

    def close(self) -> None:
        ## @brief Close the joystick handle.
        if self.native is not None:
            self.native.close()
            self.native = None
 
 

count()

int mxvk_wrap.input.Joystick.count

(

cls

)

Definition at line 16 of file input.py.

    def count(cls) -> int:
        ## @brief Return the number of connected joysticks.
        return mxvk.Joystick.count()
 

Member Data Documentation

native

mxvk_wrap.input.Joystick.native = mxvk.Joystick()

Open joystick index.

Definition at line 12 of file input.py.

---

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

• python-examples/mxvk_wrap/input.py