sdl3-bindgen-sys

Safe Haskell	None
Language	GHC2021

SDL3.Sys.Bindgen.Power

Description

SDL power management routines.

There is a single function in this category: SDL_GetPowerInfo().

This function is useful for games on the go. This allows an app to know if it's running on a draining battery, which can be useful if the app wants to reduce processing, or perhaps framerate, to extend the duration of the battery's charge. Perhaps the app just wants to show a battery meter when fullscreen, or alert the user when the power is getting extremely low, so they can save their game. The basic state for the system's power supply.

These are results returned by SDL_GetPowerInfo().

Since: 3.2.0

Synopsis

newtype SDL_PowerState = SDL_PowerState {
- unwrap :: CInt
}
pattern SDL_POWERSTATE_ERROR :: SDL_PowerState
pattern SDL_POWERSTATE_UNKNOWN :: SDL_PowerState
pattern SDL_POWERSTATE_ON_BATTERY :: SDL_PowerState
pattern SDL_POWERSTATE_NO_BATTERY :: SDL_PowerState
pattern SDL_POWERSTATE_CHARGING :: SDL_PowerState
pattern SDL_POWERSTATE_CHARGED :: SDL_PowerState

Documentation

newtype SDL_PowerState Source #

C declaration: enum SDL_PowerState, defined at SDL3/SDL_power.h 56:14

Constructors

SDL_PowerState
Fields unwrap :: CInt

Instances

Instances details

Storable SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

sizeOf :: SDL_PowerState -> Int #

alignment :: SDL_PowerState -> Int #

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

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

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

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

peek :: Ptr SDL_PowerState -> IO SDL_PowerState #

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

Generic SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Associated Types

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

Methods

from :: SDL_PowerState -> Rep SDL_PowerState x #

to :: Rep SDL_PowerState x -> SDL_PowerState #

Read SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

readsPrec :: Int -> ReadS SDL_PowerState #

readList :: ReadS [SDL_PowerState] #

readPrec :: ReadPrec SDL_PowerState #

readListPrec :: ReadPrec [SDL_PowerState] #

Show SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

showsPrec :: Int -> SDL_PowerState -> ShowS #

show :: SDL_PowerState -> String #

showList :: [SDL_PowerState] -> ShowS #

Eq SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

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

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

Ord SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

compare :: SDL_PowerState -> SDL_PowerState -> Ordering #

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

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

(>) :: SDL_PowerState -> SDL_PowerState -> Bool #

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

max :: SDL_PowerState -> SDL_PowerState -> SDL_PowerState #

min :: SDL_PowerState -> SDL_PowerState -> SDL_PowerState #

Prim SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

sizeOfType# :: Proxy SDL_PowerState -> Int# #

sizeOf# :: SDL_PowerState -> Int# #

alignmentOfType# :: Proxy SDL_PowerState -> Int# #

alignment# :: SDL_PowerState -> Int# #

indexByteArray# :: ByteArray# -> Int# -> SDL_PowerState #

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

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

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

indexOffAddr# :: Addr# -> Int# -> SDL_PowerState #

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

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

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

CEnum SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Associated Types

type CEnumZ SDL_PowerState
Instance details Defined in SDL3.Sys.Bindgen.Power type CEnumZ SDL_PowerState = CInt

Methods

toCEnum :: CEnumZ SDL_PowerState -> SDL_PowerState #

fromCEnum :: SDL_PowerState -> CEnumZ SDL_PowerState #

declaredValues :: proxy SDL_PowerState -> DeclaredValues SDL_PowerState #

showsUndeclared :: proxy SDL_PowerState -> Int -> CEnumZ SDL_PowerState -> ShowS #

readPrecUndeclared :: ReadPrec SDL_PowerState #

isDeclared :: SDL_PowerState -> Bool #

mkDeclared :: CEnumZ SDL_PowerState -> Maybe SDL_PowerState #

SequentialCEnum SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

minDeclaredValue :: SDL_PowerState #

maxDeclaredValue :: SDL_PowerState #

HasFFIType SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Associated Types

type FFIType SDL_PowerState
Instance details Defined in SDL3.Sys.Bindgen.Power type FFIType SDL_PowerState = FFIType CInt

Methods

toFFIType :: SDL_PowerState -> FFIType SDL_PowerState #

fromFFIType :: FFIType SDL_PowerState -> SDL_PowerState #

ReadRaw SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

readRaw :: Ptr SDL_PowerState -> IO SDL_PowerState #

StaticSize SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

staticSizeOf :: Proxy SDL_PowerState -> Int #

staticAlignment :: Proxy SDL_PowerState -> Int #

WriteRaw SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

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

HasCField SDL_PowerState "unwrap" Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Associated Types

type CFieldType SDL_PowerState "unwrap"
Instance details Defined in SDL3.Sys.Bindgen.Power type CFieldType SDL_PowerState "unwrap" = CInt

Methods

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

ty ~ CInt => HasField "unwrap" SDL_PowerState ty Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

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

ty ~ CInt => HasField "unwrap" (Ptr SDL_PowerState) (Ptr ty :: Type) Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

Methods

getField :: Ptr SDL_PowerState -> Ptr ty #

type Rep SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

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

type CEnumZ SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

type CEnumZ SDL_PowerState = CInt

type FFIType SDL_PowerState Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

type FFIType SDL_PowerState = FFIType CInt

type CFieldType SDL_PowerState "unwrap" Source #

Instance details

Defined in SDL3.Sys.Bindgen.Power

type CFieldType SDL_PowerState "unwrap" = CInt

pattern SDL_POWERSTATE_ERROR :: SDL_PowerState Source #

error determining power status

C declaration: SDL_POWERSTATE_ERROR, defined at SDL3/SDL_power.h 58:5

pattern SDL_POWERSTATE_UNKNOWN :: SDL_PowerState Source #

cannot determine power status

C declaration: SDL_POWERSTATE_UNKNOWN, defined at SDL3/SDL_power.h 59:5

pattern SDL_POWERSTATE_ON_BATTERY :: SDL_PowerState Source #

Not plugged in, running on the battery

C declaration: SDL_POWERSTATE_ON_BATTERY, defined at SDL3/SDL_power.h 60:5

pattern SDL_POWERSTATE_NO_BATTERY :: SDL_PowerState Source #

Plugged in, no battery available

C declaration: SDL_POWERSTATE_NO_BATTERY, defined at SDL3/SDL_power.h 61:5

pattern SDL_POWERSTATE_CHARGING :: SDL_PowerState Source #

Plugged in, charging battery

C declaration: SDL_POWERSTATE_CHARGING, defined at SDL3/SDL_power.h 62:5

pattern SDL_POWERSTATE_CHARGED :: SDL_PowerState Source #

Plugged in, battery charged

C declaration: SDL_POWERSTATE_CHARGED, defined at SDL3/SDL_power.h 63:5