Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
This is the struct that describes the categories. Once initialized with
GST_DEBUG_CATEGORY_INIT
, its values can't be changed anymore.
- newtype DebugCategory = DebugCategory (ManagedPtr DebugCategory)
- newZeroDebugCategory :: MonadIO m => m DebugCategory
- noDebugCategory :: Maybe DebugCategory
- data DebugCategoryFreeMethodInfo
- debugCategoryFree :: (HasCallStack, MonadIO m) => DebugCategory -> m ()
- data DebugCategoryGetColorMethodInfo
- debugCategoryGetColor :: (HasCallStack, MonadIO m) => DebugCategory -> m Word32
- data DebugCategoryGetDescriptionMethodInfo
- debugCategoryGetDescription :: (HasCallStack, MonadIO m) => DebugCategory -> m Text
- data DebugCategoryGetNameMethodInfo
- debugCategoryGetName :: (HasCallStack, MonadIO m) => DebugCategory -> m Text
- data DebugCategoryGetThresholdMethodInfo
- debugCategoryGetThreshold :: (HasCallStack, MonadIO m) => DebugCategory -> m DebugLevel
- data DebugCategoryResetThresholdMethodInfo
- debugCategoryResetThreshold :: (HasCallStack, MonadIO m) => DebugCategory -> m ()
- data DebugCategorySetThresholdMethodInfo
- debugCategorySetThreshold :: (HasCallStack, MonadIO m) => DebugCategory -> DebugLevel -> m ()
Exported types
newtype DebugCategory Source #
newZeroDebugCategory :: MonadIO m => m DebugCategory Source #
Construct a DebugCategory
struct initialized to zero.
Methods
free
data DebugCategoryFreeMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * DebugCategoryFreeMethodInfo DebugCategory signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> DebugCategory |
|
-> m () |
Removes and frees the category and all associated resources.
getColor
data DebugCategoryGetColorMethodInfo Source #
((~) * signature (m Word32), MonadIO m) => MethodInfo * DebugCategoryGetColorMethodInfo DebugCategory signature Source # | |
debugCategoryGetColor Source #
:: (HasCallStack, MonadIO m) | |
=> DebugCategory |
|
-> m Word32 | Returns: the color of the category. |
Returns the color of a debug category used when printing output in this category.
getDescription
data DebugCategoryGetDescriptionMethodInfo Source #
((~) * signature (m Text), MonadIO m) => MethodInfo * DebugCategoryGetDescriptionMethodInfo DebugCategory signature Source # | |
debugCategoryGetDescription Source #
:: (HasCallStack, MonadIO m) | |
=> DebugCategory |
|
-> m Text | Returns: the description of the category. |
Returns the description of a debug category.
getName
data DebugCategoryGetNameMethodInfo Source #
((~) * signature (m Text), MonadIO m) => MethodInfo * DebugCategoryGetNameMethodInfo DebugCategory signature Source # | |
:: (HasCallStack, MonadIO m) | |
=> DebugCategory |
|
-> m Text | Returns: the name of the category. |
Returns the name of a debug category.
getThreshold
data DebugCategoryGetThresholdMethodInfo Source #
((~) * signature (m DebugLevel), MonadIO m) => MethodInfo * DebugCategoryGetThresholdMethodInfo DebugCategory signature Source # | |
debugCategoryGetThreshold Source #
:: (HasCallStack, MonadIO m) | |
=> DebugCategory |
|
-> m DebugLevel | Returns: the |
Returns the threshold of a DebugCategory
.
resetThreshold
data DebugCategoryResetThresholdMethodInfo Source #
((~) * signature (m ()), MonadIO m) => MethodInfo * DebugCategoryResetThresholdMethodInfo DebugCategory signature Source # | |
debugCategoryResetThreshold Source #
:: (HasCallStack, MonadIO m) | |
=> DebugCategory |
|
-> m () |
Resets the threshold of the category to the default level. Debug information
will only be output if the threshold is lower or equal to the level of the
debugging message.
Use this function to set the threshold back to where it was after using
debugCategorySetThreshold
.
setThreshold
data DebugCategorySetThresholdMethodInfo Source #
((~) * signature (DebugLevel -> m ()), MonadIO m) => MethodInfo * DebugCategorySetThresholdMethodInfo DebugCategory signature Source # | |
debugCategorySetThreshold Source #
:: (HasCallStack, MonadIO m) | |
=> DebugCategory |
|
-> DebugLevel |
|
-> m () |
Sets the threshold of the category to the given level. Debug information will only be output if the threshold is lower or equal to the level of the debugging message. <note><para> Do not use this function in production code, because other functions may change the threshold of categories as side effect. It is however a nice function to use when debugging (even from gdb). </para></note>