Struct SDL_PenProximityEvent

#[repr(C)]
pub struct SDL_PenProximityEvent {
    pub type: SDL_EventType,
    pub reserved: u32,
    pub timestamp: u64,
    pub windowID: u32,
    pub which: u32,
}

Available on crate feature dep_sdl3 only.

Pressure-sensitive pen proximity event structure (event.pmotion.*)

When a pen becomes visible to the system (it is close enough to a tablet, etc), SDL will send an SDL_EVENT_PEN_PROXIMITY_IN event with the new pen’s ID. This ID is valid until the pen leaves proximity again (has been removed from the tablet’s area, the tablet has been unplugged, etc). If the same pen reenters proximity again, it will be given a new ID.

Note that “proximity” means “close enough for the tablet to know the tool is there.” The pen touching and lifting off from the tablet while not leaving the area are handled by SDL_EVENT_PEN_DOWN and SDL_EVENT_PEN_UP.

Availability

This struct is available since SDL 3.2.0.

Fields

type: SDL_EventType

SDL_EVENT_PEN_PROXIMITY_IN or SDL_EVENT_PEN_PROXIMITY_OUT

reserved: u32

timestamp: u64

In nanoseconds, populated using [SDL_GetTicksNS()]

windowID: u32

The window with pen focus, if any

which: u32

The pen instance id

Trait Implementations

impl Clone for SDL_PenProximityEvent

fn clone(&self) -> SDL_PenProximityEvent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SDL_PenProximityEvent

fn default() -> SDL_PenProximityEvent

Returns the “default value” for a type.

impl Copy for SDL_PenProximityEvent