Safe Haskell	None
Language	GHC2021

SDL3.Sys.Bindgen.Sensor

Description

SDL sensor management.

These APIs grant access to gyros and accelerometers on various platforms.

In order to use these functions, SDL_Init() must have been called with the SDL_INIT_SENSOR flag. This causes SDL to scan the system for sensors, and load appropriate drivers. The opaque structure used to identify an opened SDL sensor.

Since: 3.2.0

Synopsis

data SDL_Sensor
newtype SDL_SensorID = SDL_SensorID {
- unwrap :: Uint32
}
sDL_STANDARD_GRAVITY :: CFloat
newtype SDL_SensorType = SDL_SensorType {
- unwrap :: CInt
}
pattern SDL_SENSOR_INVALID :: SDL_SensorType
pattern SDL_SENSOR_UNKNOWN :: SDL_SensorType
pattern SDL_SENSOR_ACCEL :: SDL_SensorType
pattern SDL_SENSOR_GYRO :: SDL_SensorType
pattern SDL_SENSOR_ACCEL_L :: SDL_SensorType
pattern SDL_SENSOR_GYRO_L :: SDL_SensorType
pattern SDL_SENSOR_ACCEL_R :: SDL_SensorType
pattern SDL_SENSOR_GYRO_R :: SDL_SensorType
pattern SDL_SENSOR_COUNT :: SDL_SensorType

Documentation

data SDL_Sensor Source #

C declaration: struct SDL_Sensor, defined at SDL3/SDL_sensor.h 54:16

newtype SDL_SensorID Source #

This is a unique ID for a sensor for the time it is connected to the system, and is never reused for the lifetime of the application.

The value 0 is an invalid ID.

C declaration: SDL_SensorID, defined at SDL3/SDL_sensor.h 64:16

Since: 3.2.0

Constructors

SDL_SensorID
Fields unwrap :: Uint32

Instances

Instances details

Bits SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

(.&.) :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

(.|.) :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

xor :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

complement :: SDL_SensorID -> SDL_SensorID #

shift :: SDL_SensorID -> Int -> SDL_SensorID #

rotate :: SDL_SensorID -> Int -> SDL_SensorID #

zeroBits :: SDL_SensorID #

bit :: Int -> SDL_SensorID #

setBit :: SDL_SensorID -> Int -> SDL_SensorID #

clearBit :: SDL_SensorID -> Int -> SDL_SensorID #

complementBit :: SDL_SensorID -> Int -> SDL_SensorID #

testBit :: SDL_SensorID -> Int -> Bool #

bitSizeMaybe :: SDL_SensorID -> Maybe Int #

bitSize :: SDL_SensorID -> Int #

isSigned :: SDL_SensorID -> Bool #

shiftL :: SDL_SensorID -> Int -> SDL_SensorID #

unsafeShiftL :: SDL_SensorID -> Int -> SDL_SensorID #

shiftR :: SDL_SensorID -> Int -> SDL_SensorID #

unsafeShiftR :: SDL_SensorID -> Int -> SDL_SensorID #

rotateL :: SDL_SensorID -> Int -> SDL_SensorID #

rotateR :: SDL_SensorID -> Int -> SDL_SensorID #

popCount :: SDL_SensorID -> Int #

FiniteBits SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

finiteBitSize :: SDL_SensorID -> Int #

countLeadingZeros :: SDL_SensorID -> Int #

countTrailingZeros :: SDL_SensorID -> Int #

Bounded SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

minBound :: SDL_SensorID #

maxBound :: SDL_SensorID #

Enum SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

succ :: SDL_SensorID -> SDL_SensorID #

pred :: SDL_SensorID -> SDL_SensorID #

toEnum :: Int -> SDL_SensorID #

fromEnum :: SDL_SensorID -> Int #

enumFrom :: SDL_SensorID -> [SDL_SensorID] #

enumFromThen :: SDL_SensorID -> SDL_SensorID -> [SDL_SensorID] #

enumFromTo :: SDL_SensorID -> SDL_SensorID -> [SDL_SensorID] #

enumFromThenTo :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID -> [SDL_SensorID] #

Storable SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

sizeOf :: SDL_SensorID -> Int #

alignment :: SDL_SensorID -> Int #

peekElemOff :: Ptr SDL_SensorID -> Int -> IO SDL_SensorID #

pokeElemOff :: Ptr SDL_SensorID -> Int -> SDL_SensorID -> IO () #

peekByteOff :: Ptr b -> Int -> IO SDL_SensorID #

pokeByteOff :: Ptr b -> Int -> SDL_SensorID -> IO () #

peek :: Ptr SDL_SensorID -> IO SDL_SensorID #

poke :: Ptr SDL_SensorID -> SDL_SensorID -> IO () #

Generic SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Associated Types

type Rep SDL_SensorID
Instance details Defined in SDL3.Sys.Bindgen.Sensor type Rep SDL_SensorID = D1 ('MetaData "SDL_SensorID" "SDL3.Sys.Bindgen.Sensor" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_SensorID" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uint32)))

Methods

from :: SDL_SensorID -> Rep SDL_SensorID x #

to :: Rep SDL_SensorID x -> SDL_SensorID #

Ix SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

range :: (SDL_SensorID, SDL_SensorID) -> [SDL_SensorID] #

index :: (SDL_SensorID, SDL_SensorID) -> SDL_SensorID -> Int #

unsafeIndex :: (SDL_SensorID, SDL_SensorID) -> SDL_SensorID -> Int #

inRange :: (SDL_SensorID, SDL_SensorID) -> SDL_SensorID -> Bool #

rangeSize :: (SDL_SensorID, SDL_SensorID) -> Int #

unsafeRangeSize :: (SDL_SensorID, SDL_SensorID) -> Int #

Num SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

(+) :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

(-) :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

(*) :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

negate :: SDL_SensorID -> SDL_SensorID #

abs :: SDL_SensorID -> SDL_SensorID #

signum :: SDL_SensorID -> SDL_SensorID #

fromInteger :: Integer -> SDL_SensorID #

Read SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

readsPrec :: Int -> ReadS SDL_SensorID #

readList :: ReadS [SDL_SensorID] #

readPrec :: ReadPrec SDL_SensorID #

readListPrec :: ReadPrec [SDL_SensorID] #

Integral SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

quot :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

rem :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

div :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

mod :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

quotRem :: SDL_SensorID -> SDL_SensorID -> (SDL_SensorID, SDL_SensorID) #

divMod :: SDL_SensorID -> SDL_SensorID -> (SDL_SensorID, SDL_SensorID) #

toInteger :: SDL_SensorID -> Integer #

Real SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

toRational :: SDL_SensorID -> Rational #

Show SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

showsPrec :: Int -> SDL_SensorID -> ShowS #

show :: SDL_SensorID -> String #

showList :: [SDL_SensorID] -> ShowS #

Eq SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

(==) :: SDL_SensorID -> SDL_SensorID -> Bool #

(/=) :: SDL_SensorID -> SDL_SensorID -> Bool #

Ord SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

compare :: SDL_SensorID -> SDL_SensorID -> Ordering #

(<) :: SDL_SensorID -> SDL_SensorID -> Bool #

(<=) :: SDL_SensorID -> SDL_SensorID -> Bool #

(>) :: SDL_SensorID -> SDL_SensorID -> Bool #

(>=) :: SDL_SensorID -> SDL_SensorID -> Bool #

max :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

min :: SDL_SensorID -> SDL_SensorID -> SDL_SensorID #

Prim SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

sizeOfType# :: Proxy SDL_SensorID -> Int# #

sizeOf# :: SDL_SensorID -> Int# #

alignmentOfType# :: Proxy SDL_SensorID -> Int# #

alignment# :: SDL_SensorID -> Int# #

indexByteArray# :: ByteArray# -> Int# -> SDL_SensorID #

readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (# State# s, SDL_SensorID #) #

writeByteArray# :: MutableByteArray# s -> Int# -> SDL_SensorID -> State# s -> State# s #

setByteArray# :: MutableByteArray# s -> Int# -> Int# -> SDL_SensorID -> State# s -> State# s #

indexOffAddr# :: Addr# -> Int# -> SDL_SensorID #

readOffAddr# :: Addr# -> Int# -> State# s -> (# State# s, SDL_SensorID #) #

writeOffAddr# :: Addr# -> Int# -> SDL_SensorID -> State# s -> State# s #

setOffAddr# :: Addr# -> Int# -> Int# -> SDL_SensorID -> State# s -> State# s #

HasFFIType SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Associated Types

type FFIType SDL_SensorID
Instance details Defined in SDL3.Sys.Bindgen.Sensor type FFIType SDL_SensorID = FFIType Uint32

Methods

toFFIType :: SDL_SensorID -> FFIType SDL_SensorID #

fromFFIType :: FFIType SDL_SensorID -> SDL_SensorID #

ReadRaw SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

readRaw :: Ptr SDL_SensorID -> IO SDL_SensorID #

StaticSize SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

staticSizeOf :: Proxy SDL_SensorID -> Int #

staticAlignment :: Proxy SDL_SensorID -> Int #

WriteRaw SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

writeRaw :: Ptr SDL_SensorID -> SDL_SensorID -> IO () #

Bitfield SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

narrow :: SDL_SensorID -> Int -> Word64 #

extend :: Word64 -> Int -> SDL_SensorID #

HasCField SDL_SensorID "unwrap" Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Associated Types

type CFieldType SDL_SensorID "unwrap"
Instance details Defined in SDL3.Sys.Bindgen.Sensor type CFieldType SDL_SensorID "unwrap" = Uint32

Methods

offset# :: Proxy# SDL_SensorID -> Proxy# "unwrap" -> Int #

ty ~ Uint32 => HasField "unwrap" SDL_SensorID ty Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

hasField :: SDL_SensorID -> (ty -> SDL_SensorID, ty) #

ty ~ Uint32 => HasField "unwrap" (Ptr SDL_SensorID) (Ptr ty :: Type) Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

getField :: Ptr SDL_SensorID -> Ptr ty #

type Rep SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

type Rep SDL_SensorID = D1 ('MetaData "SDL_SensorID" "SDL3.Sys.Bindgen.Sensor" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_SensorID" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Uint32)))

type FFIType SDL_SensorID Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

type FFIType SDL_SensorID = FFIType Uint32

type CFieldType SDL_SensorID "unwrap" Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

type CFieldType SDL_SensorID "unwrap" = Uint32

sDL_STANDARD_GRAVITY :: CFloat Source #

A constant to represent standard gravity for accelerometer sensors.

The accelerometer returns the current acceleration in SI meters per second squared. This measurement includes the force of gravity, so a device at rest will have an value of SDL_STANDARD_GRAVITY away from the center of the earth, which is a positive Y value.

C declaration: macro SDL_STANDARD_GRAVITY, defined at SDL3/SDL_sensor.h 76:9

Since: 3.2.0

newtype SDL_SensorType Source #

The different sensors defined by SDL.

Additional sensors may be available, using platform dependent semantics.

Here are the additional Android sensors:

https://developer.android.com/reference/android/hardware/SensorEvent.html#values

Accelerometer sensor notes:

The accelerometer returns the current acceleration in SI meters per second squared. This measurement includes the force of gravity, so a device at rest will have an value of SDL_STANDARD_GRAVITY away from the center of the earth, which is a positive Y value.

values[0]: Acceleration on the x axis
values[1]: Acceleration on the y axis
values[2]: Acceleration on the z axis

For phones and tablets held in natural orientation and game controllers held in front of you, the axes are defined as follows:

-X ... +X : left ... right
-Y ... +Y : bottom ... top
-Z ... +Z : farther ... closer

The accelerometer axis data is not changed when the device is rotated.

Gyroscope sensor notes:

The gyroscope returns the current rate of rotation in radians per second. The rotation is positive in the counter-clockwise direction. That is, an observer looking from a positive location on one of the axes would see positive rotation on that axis when it appeared to be rotating counter-clockwise.

values[0]: Angular speed around the x axis (pitch)
values[1]: Angular speed around the y axis (yaw)
values[2]: Angular speed around the z axis (roll)

For phones and tablets held in natural orientation and game controllers held in front of you, the axes are defined as follows:

-X ... +X : left ... right
-Y ... +Y : bottom ... top
-Z ... +Z : farther ... closer

The gyroscope axis data is not changed when the device is rotated.

See also: SDL_GetCurrentDisplayOrientation
C declaration: enum SDL_SensorType, defined at SDL3/SDL_sensor.h 132:14

Since: 3.2.0

Constructors

SDL_SensorType
Fields unwrap :: CInt

Instances

Instances details

Storable SDL_SensorType Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Methods

sizeOf :: SDL_SensorType -> Int #

alignment :: SDL_SensorType -> Int #

peekElemOff :: Ptr SDL_SensorType -> Int -> IO SDL_SensorType #

pokeElemOff :: Ptr SDL_SensorType -> Int -> SDL_SensorType -> IO () #

peekByteOff :: Ptr b -> Int -> IO SDL_SensorType #

pokeByteOff :: Ptr b -> Int -> SDL_SensorType -> IO () #

peek :: Ptr SDL_SensorType -> IO SDL_SensorType #

poke :: Ptr SDL_SensorType -> SDL_SensorType -> IO () #

Generic SDL_SensorType Source #

Instance details

Defined in SDL3.Sys.Bindgen.Sensor

Associated Types

type Rep SDL_SensorType
Instance details Defined in SDL3.Sys.Bindgen.Sensor type Rep SDL_SensorType = D1 ('MetaData "SDL_SensorType" "SDL3.Sys.Bindgen.Sensor" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_SensorType" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CInt)))