Skip to main content

SDL_PenProximityEvent

Struct SDL_PenProximityEvent 

Source
#[repr(C)]
pub struct SDL_PenProximityEvent { pub type_: SDL_EventType, pub reserved: Uint32, pub timestamp: Uint64, pub windowID: SDL_WindowID, pub which: SDL_PenID, }
Expand description

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

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.

Not all platforms have a window associated with the pen during proximity events. Some wait until motion/button/etc events to offer this info.

Available Since: 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: Uint32§timestamp: Uint64

< In nanoseconds, populated using SDL_GetTicksNS()

§windowID: SDL_WindowID

< The window with pen focus, if any

§which: SDL_PenID

< The pen instance id

Trait Implementations§

Source§

impl Clone for SDL_PenProximityEvent

Source§

fn clone(&self) -> SDL_PenProximityEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SDL_PenProximityEvent

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SDL_PenProximityEvent

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Hash for SDL_PenProximityEvent

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Copy for SDL_PenProximityEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.