Struct SDL_PenAxis

#[repr(transparent)]
pub struct SDL_PenAxis(pub i32);

Available on crate feature dep_sdl3 only.

Pen axis indices.

These are the valid values for the axis field in [SDL_PenAxisEvent]. All axes are either normalised to 0..1 or report a (positive or negative) angle in degrees, with 0.0 representing the centre. Not all pens/backends support all axes: unsupported axes are always zero.

To convert angles for tilt and rotation into vector representation, use SDL_sinf on the XTILT, YTILT, or ROTATION component, for example:

SDL_sinf(xtilt * SDL_PI_F / 180.0).

Availability

This enum is available since SDL 3.2.0.

Known values (sdl3-sys)

Associated constant	Global constant	Description
PRESSURE	SDL_PEN_AXIS_PRESSURE	Pen pressure. Unidirectional: 0 to 1.0
XTILT	SDL_PEN_AXIS_XTILT	Pen horizontal tilt angle. Bidirectional: -90.0 to 90.0 (left-to-right).
YTILT	SDL_PEN_AXIS_YTILT	Pen vertical tilt angle. Bidirectional: -90.0 to 90.0 (top-to-down).
DISTANCE	SDL_PEN_AXIS_DISTANCE	Pen distance to drawing surface. Unidirectional: 0.0 to 1.0
ROTATION	SDL_PEN_AXIS_ROTATION	Pen barrel rotation. Bidirectional: -180 to 179.9 (clockwise, 0 is facing up, -180.0 is facing down).
SLIDER	SDL_PEN_AXIS_SLIDER	Pen finger wheel or slider (e.g., Airbrush Pen). Unidirectional: 0 to 1.0
TANGENTIAL_PRESSURE	SDL_PEN_AXIS_TANGENTIAL_PRESSURE	Pressure from squeezing the pen (“barrel pressure”).
COUNT	SDL_PEN_AXIS_COUNT	Total known pen axis types in this version of SDL. This number may grow in future releases!

Tuple Fields

0: i32

Implementations

impl SDL_PenAxis

pub const PRESSURE: SDL_PenAxis

Pen pressure. Unidirectional: 0 to 1.0

pub const XTILT: SDL_PenAxis

Pen horizontal tilt angle. Bidirectional: -90.0 to 90.0 (left-to-right).

pub const YTILT: SDL_PenAxis

Pen vertical tilt angle. Bidirectional: -90.0 to 90.0 (top-to-down).

pub const DISTANCE: SDL_PenAxis

Pen distance to drawing surface. Unidirectional: 0.0 to 1.0

pub const ROTATION: SDL_PenAxis

Pen barrel rotation. Bidirectional: -180 to 179.9 (clockwise, 0 is facing up, -180.0 is facing down).

pub const SLIDER: SDL_PenAxis

Pen finger wheel or slider (e.g., Airbrush Pen). Unidirectional: 0 to 1.0

pub const TANGENTIAL_PRESSURE: SDL_PenAxis

Pressure from squeezing the pen (“barrel pressure”).

pub const COUNT: SDL_PenAxis

Total known pen axis types in this version of SDL. This number may grow in future releases!

Trait Implementations

impl Clone for SDL_PenAxis

fn clone(&self) -> SDL_PenAxis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SDL_PenAxis

fn default() -> SDL_PenAxis

Returns the “default value” for a type.

impl From<SDL_PenAxis> for i32

fn from(value: SDL_PenAxis) -> i32

Converts to this type from the input type.

impl Hash for SDL_PenAxis

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SDL_PenAxis

fn cmp(&self, other: &SDL_PenAxis) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SDL_PenAxis

fn eq(&self, other: &SDL_PenAxis) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SDL_PenAxis

fn partial_cmp(&self, other: &SDL_PenAxis) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SDL_PenAxis

impl Eq for SDL_PenAxis

impl StructuralPartialEq for SDL_PenAxis