Struct RetroDevice

pub struct RetroDevice {
    bits: u8,
}

Bitflags indicating the type of input device

Fields

bits: u8

Implementations

impl RetroDevice

pub const NONE: Self

Input disabled

pub const JOYPAD: Self

The JOYPAD is called RetroPad. It is essentially a Super Nintendo controller, but with additional L2/R2/L3/R3 buttons, similar to a PS1 DualShock.

pub const MOUSE: Self

The mouse is a simple mouse, similar to Super Nintendo’s mouse. X and Y coordinates are reported relatively to last poll (poll callback). It is up to the libretro implementation to keep track of where the mouse pointer is supposed to be on the screen. The frontend must make sure not to interfere with its own hardware mouse pointer.

pub const KEYBOARD: Self

KEYBOARD device lets one poll for raw key pressed. It is poll based, so input callback will return with the current pressed state. For event/text based keyboard input, see RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK.

pub const LIGHTGUN: Self

LIGHTGUN device is similar to Guncon-2 for PlayStation 2. It reports X/Y coordinates in screen space (similar to the pointer) in the range [-0x8000, 0x7fff] in both axes, with zero being center and -0x8000 being out of bounds. As well as reporting on/off screen state. It features a trigger, start/select buttons, auxiliary action buttons and a directional pad. A forced off-screen shot can be requested for auto-reloading function in some games.

pub const ANALOG: Self

The ANALOG device is an extension to JOYPAD (RetroPad). Similar to DualShock2 it adds two analog sticks and all buttons can be analog. This is treated as a separate device type as it returns axis values in the full analog range of [-0x7fff, 0x7fff], although some devices may return -0x8000. Positive X axis is right. Positive Y axis is down. Buttons are returned in the range [0, 0x7fff]. Only use ANALOG type when polling for analog values.

pub const POINTER: Self

Abstracts the concept of a pointing mechanism, e.g. touch. This allows libretro to query in absolute coordinates where on the screen a mouse (or something similar) is being placed. For a touch centric device, coordinates reported are the coordinates of the press.

Coordinates in X and Y are reported as: [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen, and 0x7fff corresponds to the far right/bottom of the screen. The “screen” is here defined as area that is passed to the frontend and later displayed on the monitor.

The frontend is free to scale/resize this screen as it sees fit, however, (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the game image, etc.

To check if the pointer coordinates are valid (e.g. a touch display actually being touched), PRESSED returns 1 or 0.

If using a mouse on a desktop, PRESSED will usually correspond to the left mouse button, but this is a frontend decision. PRESSED will only return 1 if the pointer is inside the game screen.

For multi-touch, the index variable can be used to successively query more presses. If index = 0 returns true for _PRESSED, coordinates can be extracted with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with index = 1, and so on. Eventually _PRESSED will return false for an index. No further presses are registered at this point.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u8) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for RetroDevice

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

Formats the value using the given formatter.

impl BitAnd for RetroDevice

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

Returns the intersection between the two sets of flags.

type Output = RetroDevice

The resulting type after applying the & operator.

impl BitAndAssign for RetroDevice

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for RetroDevice

fn bitor(self, other: RetroDevice) -> Self

Returns the union of the two sets of flags.

type Output = RetroDevice

The resulting type after applying the | operator.

impl BitOrAssign for RetroDevice

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for RetroDevice

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

Returns the left flags, but with all the right flags toggled.

type Output = RetroDevice

The resulting type after applying the ^ operator.

impl BitXorAssign for RetroDevice

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for RetroDevice

fn clone(&self) -> RetroDevice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetroDevice

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

Formats the value using the given formatter.

impl Extend<RetroDevice> for RetroDevice

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<RetroDevice> for RetroDevice

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for RetroDevice

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

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 LowerHex for RetroDevice

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

Formats the value using the given formatter.

impl Not for RetroDevice

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = RetroDevice

The resulting type after applying the ! operator.

impl Octal for RetroDevice

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

Formats the value using the given formatter.

impl Ord for RetroDevice

fn cmp(&self, other: &RetroDevice) -> 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 RetroDevice

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

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

const 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 RetroDevice

fn partial_cmp(&self, other: &RetroDevice) -> 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 Sub for RetroDevice

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

Returns the set difference of the two sets of flags.

type Output = RetroDevice

The resulting type after applying the - operator.

impl SubAssign for RetroDevice

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for RetroDevice

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

Formats the value using the given formatter.

impl Copy for RetroDevice

impl Eq for RetroDevice

impl StructuralPartialEq for RetroDevice