gi-gdk-0.3.16.12: GI/Gdk/Structs/FrameTimings.hs

{- |
Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
License    : LGPL-2.1
Maintainer : Iñaki García Etxebarria (garetxe@gmail.com)

A #GdkFrameTimings object holds timing information for a single frame
of the application’s displays. To retrieve #GdkFrameTimings objects,
use gdk_frame_clock_get_timings() or gdk_frame_clock_get_current_timings().
The information in #GdkFrameTimings is useful for precise synchronization
of video with the event or audio streams, and for measuring
quality metrics for the application’s display, such as latency and jitter.
-}

module GI.Gdk.Structs.FrameTimings
    ( 

-- * Exported types
    FrameTimings(..)                        ,
    noFrameTimings                          ,


 -- * Methods
-- ** frameTimingsGetComplete
    frameTimingsGetComplete                 ,


-- ** frameTimingsGetFrameCounter
    frameTimingsGetFrameCounter             ,


-- ** frameTimingsGetFrameTime
    frameTimingsGetFrameTime                ,


-- ** frameTimingsGetPredictedPresentationTime
    frameTimingsGetPredictedPresentationTime,


-- ** frameTimingsGetPresentationTime
    frameTimingsGetPresentationTime         ,


-- ** frameTimingsGetRefreshInterval
    frameTimingsGetRefreshInterval          ,


-- ** frameTimingsRef
    frameTimingsRef                         ,


-- ** frameTimingsUnref
    frameTimingsUnref                       ,




    ) where

import Prelude ()
import Data.GI.Base.ShortPrelude

import qualified Data.Text as T
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map

import GI.Gdk.Types
import GI.Gdk.Callbacks

newtype FrameTimings = FrameTimings (ForeignPtr FrameTimings)
foreign import ccall "gdk_frame_timings_get_type" c_gdk_frame_timings_get_type :: 
    IO GType

instance BoxedObject FrameTimings where
    boxedType _ = c_gdk_frame_timings_get_type

noFrameTimings :: Maybe FrameTimings
noFrameTimings = Nothing

-- method FrameTimings::get_complete
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TBoolean
-- throws : False
-- Skip return : False

foreign import ccall "gdk_frame_timings_get_complete" gdk_frame_timings_get_complete :: 
    Ptr FrameTimings ->                     -- _obj : TInterface "Gdk" "FrameTimings"
    IO CInt


frameTimingsGetComplete ::
    (MonadIO m) =>
    FrameTimings ->                         -- _obj
    m Bool
frameTimingsGetComplete _obj = liftIO $ do
    let _obj' = unsafeManagedPtrGetPtr _obj
    result <- gdk_frame_timings_get_complete _obj'
    let result' = (/= 0) result
    touchManagedPtr _obj
    return result'

-- method FrameTimings::get_frame_counter
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TInt64
-- throws : False
-- Skip return : False

foreign import ccall "gdk_frame_timings_get_frame_counter" gdk_frame_timings_get_frame_counter :: 
    Ptr FrameTimings ->                     -- _obj : TInterface "Gdk" "FrameTimings"
    IO Int64


frameTimingsGetFrameCounter ::
    (MonadIO m) =>
    FrameTimings ->                         -- _obj
    m Int64
frameTimingsGetFrameCounter _obj = liftIO $ do
    let _obj' = unsafeManagedPtrGetPtr _obj
    result <- gdk_frame_timings_get_frame_counter _obj'
    touchManagedPtr _obj
    return result

-- method FrameTimings::get_frame_time
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TInt64
-- throws : False
-- Skip return : False

foreign import ccall "gdk_frame_timings_get_frame_time" gdk_frame_timings_get_frame_time :: 
    Ptr FrameTimings ->                     -- _obj : TInterface "Gdk" "FrameTimings"
    IO Int64


frameTimingsGetFrameTime ::
    (MonadIO m) =>
    FrameTimings ->                         -- _obj
    m Int64
frameTimingsGetFrameTime _obj = liftIO $ do
    let _obj' = unsafeManagedPtrGetPtr _obj
    result <- gdk_frame_timings_get_frame_time _obj'
    touchManagedPtr _obj
    return result

-- method FrameTimings::get_predicted_presentation_time
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TInt64
-- throws : False
-- Skip return : False

foreign import ccall "gdk_frame_timings_get_predicted_presentation_time" gdk_frame_timings_get_predicted_presentation_time :: 
    Ptr FrameTimings ->                     -- _obj : TInterface "Gdk" "FrameTimings"
    IO Int64


frameTimingsGetPredictedPresentationTime ::
    (MonadIO m) =>
    FrameTimings ->                         -- _obj
    m Int64
frameTimingsGetPredictedPresentationTime _obj = liftIO $ do
    let _obj' = unsafeManagedPtrGetPtr _obj
    result <- gdk_frame_timings_get_predicted_presentation_time _obj'
    touchManagedPtr _obj
    return result

-- method FrameTimings::get_presentation_time
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TInt64
-- throws : False
-- Skip return : False

foreign import ccall "gdk_frame_timings_get_presentation_time" gdk_frame_timings_get_presentation_time :: 
    Ptr FrameTimings ->                     -- _obj : TInterface "Gdk" "FrameTimings"
    IO Int64


frameTimingsGetPresentationTime ::
    (MonadIO m) =>
    FrameTimings ->                         -- _obj
    m Int64
frameTimingsGetPresentationTime _obj = liftIO $ do
    let _obj' = unsafeManagedPtrGetPtr _obj
    result <- gdk_frame_timings_get_presentation_time _obj'
    touchManagedPtr _obj
    return result

-- method FrameTimings::get_refresh_interval
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TInt64
-- throws : False
-- Skip return : False

foreign import ccall "gdk_frame_timings_get_refresh_interval" gdk_frame_timings_get_refresh_interval :: 
    Ptr FrameTimings ->                     -- _obj : TInterface "Gdk" "FrameTimings"
    IO Int64


frameTimingsGetRefreshInterval ::
    (MonadIO m) =>
    FrameTimings ->                         -- _obj
    m Int64
frameTimingsGetRefreshInterval _obj = liftIO $ do
    let _obj' = unsafeManagedPtrGetPtr _obj
    result <- gdk_frame_timings_get_refresh_interval _obj'
    touchManagedPtr _obj
    return result

-- method FrameTimings::ref
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TInterface "Gdk" "FrameTimings"
-- throws : False
-- Skip return : False

foreign import ccall "gdk_frame_timings_ref" gdk_frame_timings_ref :: 
    Ptr FrameTimings ->                     -- _obj : TInterface "Gdk" "FrameTimings"
    IO (Ptr FrameTimings)


frameTimingsRef ::
    (MonadIO m) =>
    FrameTimings ->                         -- _obj
    m FrameTimings
frameTimingsRef _obj = liftIO $ do
    let _obj' = unsafeManagedPtrGetPtr _obj
    result <- gdk_frame_timings_ref _obj'
    checkUnexpectedReturnNULL "gdk_frame_timings_ref" result
    result' <- (wrapBoxed FrameTimings) result
    touchManagedPtr _obj
    return result'

-- method FrameTimings::unref
-- method type : OrdinaryMethod
-- Args : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- Lengths : []
-- hInArgs : [Arg {argName = "_obj", argType = TInterface "Gdk" "FrameTimings", direction = DirectionIn, mayBeNull = False, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, transfer = TransferNothing}]
-- returnType : TBasicType TVoid
-- throws : False
-- Skip return : False

foreign import ccall "gdk_frame_timings_unref" gdk_frame_timings_unref :: 
    Ptr FrameTimings ->                     -- _obj : TInterface "Gdk" "FrameTimings"
    IO ()


frameTimingsUnref ::
    (MonadIO m) =>
    FrameTimings ->                         -- _obj
    m ()
frameTimingsUnref _obj = liftIO $ do
    let _obj' = unsafeManagedPtrGetPtr _obj
    gdk_frame_timings_unref _obj'
    touchManagedPtr _obj
    return ()