sdl3-bindgen-sys
Safe HaskellNone
LanguageGHC2021

SDL3.Sys.Bindgen.Time

Description

SDL realtime clock and date/time routines.

There are two data types that are used in this category: SDL_Time, which represents the nanoseconds since a specific moment (an "epoch"), and SDL_DateTime, which breaks time down into human-understandable components: years, months, days, hours, etc.

Much of the functionality is involved in converting those two types to other useful forms. A structure holding a calendar date and time broken down into its components.

Since: 3.2.0

Synopsis

Documentation

data SDL_DateTime Source #

C declaration
struct SDL_DateTime, defined at SDL3/SDL_time.h 54:16

Constructors

SDL_DateTime 

Fields

  • year :: CInt

    Year

    C declaration
    year, defined at SDL3/SDL_time.h 56:9
  • month :: CInt

    Month [01-12]

    C declaration
    month, defined at SDL3/SDL_time.h 57:9
  • day :: CInt

    Day of the month [01-31]

    C declaration
    day, defined at SDL3/SDL_time.h 58:9
  • hour :: CInt

    Hour [0-23]

    C declaration
    hour, defined at SDL3/SDL_time.h 59:9
  • minute :: CInt

    Minute [0-59]

    C declaration
    minute, defined at SDL3/SDL_time.h 60:9
  • second :: CInt

    Seconds [0-60]

    C declaration
    second, defined at SDL3/SDL_time.h 61:9
  • nanosecond :: CInt

    Nanoseconds [0-999999999]

    C declaration
    nanosecond, defined at SDL3/SDL_time.h 62:9
  • day_of_week :: CInt

    Day of the week [0-6] (0 being Sunday)

    C declaration
    day_of_week, defined at SDL3/SDL_time.h 63:9
  • utc_offset :: CInt

    Seconds east of UTC

    C declaration
    utc_offset, defined at SDL3/SDL_time.h 64:9

Instances

Instances details
Storable SDL_DateTime Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Generic SDL_DateTime Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Show SDL_DateTime Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Eq SDL_DateTime Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

ReadRaw SDL_DateTime Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

StaticSize SDL_DateTime Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

WriteRaw SDL_DateTime Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

IsStruct SDL_DateTime Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

zero :: SDL_DateTime #

HasCField SDL_DateTime "day" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateTime "day" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

offset# :: Proxy# SDL_DateTime -> Proxy# "day" -> Int #

HasCField SDL_DateTime "day_of_week" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateTime "day_of_week" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "day_of_week" = CInt

Methods

offset# :: Proxy# SDL_DateTime -> Proxy# "day_of_week" -> Int #

HasCField SDL_DateTime "hour" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateTime "hour" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

offset# :: Proxy# SDL_DateTime -> Proxy# "hour" -> Int #

HasCField SDL_DateTime "minute" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateTime "minute" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "minute" = CInt

Methods

offset# :: Proxy# SDL_DateTime -> Proxy# "minute" -> Int #

HasCField SDL_DateTime "month" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateTime "month" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

offset# :: Proxy# SDL_DateTime -> Proxy# "month" -> Int #

HasCField SDL_DateTime "nanosecond" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateTime "nanosecond" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "nanosecond" = CInt

Methods

offset# :: Proxy# SDL_DateTime -> Proxy# "nanosecond" -> Int #

HasCField SDL_DateTime "second" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateTime "second" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "second" = CInt

Methods

offset# :: Proxy# SDL_DateTime -> Proxy# "second" -> Int #

HasCField SDL_DateTime "utc_offset" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateTime "utc_offset" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "utc_offset" = CInt

Methods

offset# :: Proxy# SDL_DateTime -> Proxy# "utc_offset" -> Int #

HasCField SDL_DateTime "year" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateTime "year" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

offset# :: Proxy# SDL_DateTime -> Proxy# "year" -> Int #

ty ~ CInt => HasField "day" SDL_DateTime ty Source #

Day of the month [01-31]

C declaration
day, defined at SDL3/SDL_time.h 58:9
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CInt => HasField "day_of_week" SDL_DateTime ty Source #

Day of the week [0-6] (0 being Sunday)

C declaration
day_of_week, defined at SDL3/SDL_time.h 63:9
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CInt => HasField "hour" SDL_DateTime ty Source #

Hour [0-23]

C declaration
hour, defined at SDL3/SDL_time.h 59:9
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CInt => HasField "minute" SDL_DateTime ty Source #

Minute [0-59]

C declaration
minute, defined at SDL3/SDL_time.h 60:9
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CInt => HasField "month" SDL_DateTime ty Source #

Month [01-12]

C declaration
month, defined at SDL3/SDL_time.h 57:9
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CInt => HasField "nanosecond" SDL_DateTime ty Source #

Nanoseconds [0-999999999]

C declaration
nanosecond, defined at SDL3/SDL_time.h 62:9
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CInt => HasField "second" SDL_DateTime ty Source #

Seconds [0-60]

C declaration
second, defined at SDL3/SDL_time.h 61:9
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CInt => HasField "utc_offset" SDL_DateTime ty Source #

Seconds east of UTC

C declaration
utc_offset, defined at SDL3/SDL_time.h 64:9
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CInt => HasField "year" SDL_DateTime ty Source #

Year

C declaration
year, defined at SDL3/SDL_time.h 56:9
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CInt => HasField "day" (Ptr SDL_DateTime) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateTime -> Ptr ty #

ty ~ CInt => HasField "day_of_week" (Ptr SDL_DateTime) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateTime -> Ptr ty #

ty ~ CInt => HasField "hour" (Ptr SDL_DateTime) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateTime -> Ptr ty #

ty ~ CInt => HasField "minute" (Ptr SDL_DateTime) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateTime -> Ptr ty #

ty ~ CInt => HasField "month" (Ptr SDL_DateTime) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateTime -> Ptr ty #

ty ~ CInt => HasField "nanosecond" (Ptr SDL_DateTime) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateTime -> Ptr ty #

ty ~ CInt => HasField "second" (Ptr SDL_DateTime) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateTime -> Ptr ty #

ty ~ CInt => HasField "utc_offset" (Ptr SDL_DateTime) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateTime -> Ptr ty #

ty ~ CInt => HasField "year" (Ptr SDL_DateTime) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateTime -> Ptr ty #

type Rep SDL_DateTime Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "day" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "day_of_week" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "day_of_week" = CInt
type CFieldType SDL_DateTime "hour" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "minute" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "minute" = CInt
type CFieldType SDL_DateTime "month" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "nanosecond" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "nanosecond" = CInt
type CFieldType SDL_DateTime "second" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "second" = CInt
type CFieldType SDL_DateTime "utc_offset" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateTime "utc_offset" = CInt
type CFieldType SDL_DateTime "year" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

newtype SDL_DateFormat Source #

The preferred date format of the current system locale.

See also
sDL_GetDateTimeLocalePreferences
C declaration
enum SDL_DateFormat, defined at SDL3/SDL_time.h 74:14

Since: 3.2.0

Constructors

SDL_DateFormat 

Fields

Instances

Instances details
Storable SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Generic SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type Rep SDL_DateFormat 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type Rep SDL_DateFormat = D1 ('MetaData "SDL_DateFormat" "SDL3.Sys.Bindgen.Time" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_DateFormat" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt)))
Read SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Show SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Eq SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Ord SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Prim SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

CEnum SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CEnumZ SDL_DateFormat 
Instance details

Defined in SDL3.Sys.Bindgen.Time

SequentialCEnum SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

HasFFIType SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type FFIType SDL_DateFormat 
Instance details

Defined in SDL3.Sys.Bindgen.Time

ReadRaw SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

StaticSize SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

WriteRaw SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

HasCField SDL_DateFormat "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_DateFormat "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CUInt => HasField "unwrap" SDL_DateFormat ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CUInt => HasField "unwrap" (Ptr SDL_DateFormat) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_DateFormat -> Ptr ty #

type Rep SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type Rep SDL_DateFormat = D1 ('MetaData "SDL_DateFormat" "SDL3.Sys.Bindgen.Time" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_DateFormat" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt)))
type CEnumZ SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type FFIType SDL_DateFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_DateFormat "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

pattern SDL_DATE_FORMAT_YYYYMMDD :: SDL_DateFormat Source #

Year/Month/Day

C declaration
SDL_DATE_FORMAT_YYYYMMDD, defined at SDL3/SDL_time.h 76:5

pattern SDL_DATE_FORMAT_DDMMYYYY :: SDL_DateFormat Source #

Day/Month/Year

C declaration
SDL_DATE_FORMAT_DDMMYYYY, defined at SDL3/SDL_time.h 77:5

pattern SDL_DATE_FORMAT_MMDDYYYY :: SDL_DateFormat Source #

Month/Day/Year

C declaration
SDL_DATE_FORMAT_MMDDYYYY, defined at SDL3/SDL_time.h 78:5

newtype SDL_TimeFormat Source #

The preferred time format of the current system locale.

See also
sDL_GetDateTimeLocalePreferences
C declaration
enum SDL_TimeFormat, defined at SDL3/SDL_time.h 88:14

Since: 3.2.0

Constructors

SDL_TimeFormat 

Fields

Instances

Instances details
Storable SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Generic SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type Rep SDL_TimeFormat 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type Rep SDL_TimeFormat = D1 ('MetaData "SDL_TimeFormat" "SDL3.Sys.Bindgen.Time" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_TimeFormat" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt)))
Read SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Show SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Eq SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Ord SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Prim SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

CEnum SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CEnumZ SDL_TimeFormat 
Instance details

Defined in SDL3.Sys.Bindgen.Time

SequentialCEnum SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

HasFFIType SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type FFIType SDL_TimeFormat 
Instance details

Defined in SDL3.Sys.Bindgen.Time

ReadRaw SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

StaticSize SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

WriteRaw SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

HasCField SDL_TimeFormat "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Associated Types

type CFieldType SDL_TimeFormat "unwrap" 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CUInt => HasField "unwrap" SDL_TimeFormat ty Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

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

ty ~ CUInt => HasField "unwrap" (Ptr SDL_TimeFormat) (Ptr ty :: Type) Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

Methods

getField :: Ptr SDL_TimeFormat -> Ptr ty #

type Rep SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type Rep SDL_TimeFormat = D1 ('MetaData "SDL_TimeFormat" "SDL3.Sys.Bindgen.Time" "sdl3-bindgen-sys-0.0.1.0-inplace" 'True) (C1 ('MetaCons "SDL_TimeFormat" 'PrefixI 'True) (S1 ('MetaSel ('Just "unwrap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CUInt)))
type CEnumZ SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type FFIType SDL_TimeFormat Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

type CFieldType SDL_TimeFormat "unwrap" Source # 
Instance details

Defined in SDL3.Sys.Bindgen.Time

pattern SDL_TIME_FORMAT_24HR :: SDL_TimeFormat Source #

24 hour time

C declaration
SDL_TIME_FORMAT_24HR, defined at SDL3/SDL_time.h 90:5

pattern SDL_TIME_FORMAT_12HR :: SDL_TimeFormat Source #

12 hour time

C declaration
SDL_TIME_FORMAT_12HR, defined at SDL3/SDL_time.h 91:5