Struct SDL_VirtualJoystickDesc

#[repr(C)]
pub struct SDL_VirtualJoystickDesc {

    pub version: u32,
    pub type: u16,
    pub padding: u16,
    pub vendor_id: u16,
    pub product_id: u16,
    pub naxes: u16,
    pub nbuttons: u16,
    pub nballs: u16,
    pub nhats: u16,
    pub ntouchpads: u16,
    pub nsensors: u16,
    pub padding2: [u16; 2],
    pub button_mask: u32,
    pub axis_mask: u32,
    pub name: *const i8,
    pub touchpads: *const SDL_VirtualJoystickTouchpadDesc,
    pub sensors: *const SDL_VirtualJoystickSensorDesc,
    pub userdata: *mut c_void,
    pub Update: Option<unsafe extern "C" fn(_: *mut c_void)>,
    pub SetPlayerIndex: Option<unsafe extern "C" fn(_: *mut c_void, _: i32)>,
    pub Rumble: Option<unsafe extern "C" fn(_: *mut c_void, _: u16, _: u16) -> bool>,
    pub RumbleTriggers: Option<unsafe extern "C" fn(_: *mut c_void, _: u16, _: u16) -> bool>,
    pub SetLED: Option<unsafe extern "C" fn(_: *mut c_void, _: u8, _: u8, _: u8) -> bool>,
    pub SendEffect: Option<unsafe extern "C" fn(_: *mut c_void, _: *const c_void, _: i32) -> bool>,
    pub SetSensorsEnabled: Option<unsafe extern "C" fn(_: *mut c_void, _: bool) -> bool>,
    pub Cleanup: Option<unsafe extern "C" fn(_: *mut c_void)>,
}

Available on crate feature dep_sdl3 only.

The structure that describes a virtual joystick.

This structure should be initialized using SDL_INIT_INTERFACE(). All elements of this structure are optional.

Availability

This struct is available since SDL 3.2.0.

See also

• SDL_AttachVirtualJoystick
• SDL_INIT_INTERFACE
• SDL_VirtualJoystickSensorDesc
• SDL_VirtualJoystickTouchpadDesc

Fields

version: u32

the version of this interface

type: u16

SDL_JoystickType

padding: u16

unused

vendor_id: u16

the USB vendor ID of this joystick

product_id: u16

the USB product ID of this joystick

naxes: u16

the number of axes on this joystick

nbuttons: u16

the number of buttons on this joystick

nballs: u16

the number of balls on this joystick

nhats: u16

the number of hats on this joystick

ntouchpads: u16

the number of touchpads on this joystick, requires touchpads to point at valid descriptions

nsensors: u16

the number of sensors on this joystick, requires sensors to point at valid descriptions

padding2: [u16; 2]

unused

button_mask: u32

A mask of which buttons are valid for this controller e.g. (1 << [SDL_GAMEPAD_BUTTON_SOUTH])

axis_mask: u32

A mask of which axes are valid for this controller e.g. (1 << [SDL_GAMEPAD_AXIS_LEFTX])

name: *const i8

the name of the joystick

touchpads: *const SDL_VirtualJoystickTouchpadDesc

A pointer to an array of touchpad descriptions, required if ntouchpads is > 0

sensors: *const SDL_VirtualJoystickSensorDesc

A pointer to an array of sensor descriptions, required if nsensors is > 0

userdata: *mut c_void

User data pointer passed to callbacks

Update: Option<unsafe extern "C" fn(_: *mut c_void)>

Called when the joystick state should be updated

SetPlayerIndex: Option<unsafe extern "C" fn(_: *mut c_void, _: i32)>

Called when the player index is set

Rumble: Option<unsafe extern "C" fn(_: *mut c_void, _: u16, _: u16) -> bool>

Implements SDL_RumbleJoystick()

RumbleTriggers: Option<unsafe extern "C" fn(_: *mut c_void, _: u16, _: u16) -> bool>

Implements SDL_RumbleJoystickTriggers()

SetLED: Option<unsafe extern "C" fn(_: *mut c_void, _: u8, _: u8, _: u8) -> bool>

Implements SDL_SetJoystickLED()

SendEffect: Option<unsafe extern "C" fn(_: *mut c_void, _: *const c_void, _: i32) -> bool>

Implements SDL_SendJoystickEffect()

SetSensorsEnabled: Option<unsafe extern "C" fn(_: *mut c_void, _: bool) -> bool>

Implements [SDL_SetGamepadSensorEnabled()]

Cleanup: Option<unsafe extern "C" fn(_: *mut c_void)>

Cleans up the userdata when the joystick is detached

Implementations

impl SDL_VirtualJoystickDesc

pub const fn new() -> SDL_VirtualJoystickDesc

Create a new SDL_VirtualJoystickDesc initialized with SDL_INIT_INTERFACE

Trait Implementations

impl Default for SDL_VirtualJoystickDesc

fn default() -> SDL_VirtualJoystickDesc

Create a new SDL_VirtualJoystickDesc initialized with SDL_INIT_INTERFACE