| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gst.Structs.DebugCategory
Contents
Description
This is the struct that describes the categories. Once initialized with
GST_DEBUG_CATEGORY_INIT, its values can't be changed anymore.
Synopsis
- newtype DebugCategory = DebugCategory (ManagedPtr DebugCategory)
- newZeroDebugCategory :: MonadIO m => m DebugCategory
- noDebugCategory :: Maybe DebugCategory
- debugCategoryFree :: (HasCallStack, MonadIO m) => DebugCategory -> m ()
- debugCategoryGetColor :: (HasCallStack, MonadIO m) => DebugCategory -> m Word32
- debugCategoryGetDescription :: (HasCallStack, MonadIO m) => DebugCategory -> m Text
- debugCategoryGetName :: (HasCallStack, MonadIO m) => DebugCategory -> m Text
- debugCategoryGetThreshold :: (HasCallStack, MonadIO m) => DebugCategory -> m DebugLevel
- debugCategoryResetThreshold :: (HasCallStack, MonadIO m) => DebugCategory -> m ()
- debugCategorySetThreshold :: (HasCallStack, MonadIO m) => DebugCategory -> DebugLevel -> m ()
Exported types
newtype DebugCategory Source #
Memory-managed wrapper type.
Constructors
| DebugCategory (ManagedPtr DebugCategory) |
Instances
| WrappedPtr DebugCategory Source # | |
Defined in GI.Gst.Structs.DebugCategory Methods wrappedPtrCalloc :: IO (Ptr DebugCategory) # | |
| tag ~ AttrSet => Constructible DebugCategory tag Source # | |
Defined in GI.Gst.Structs.DebugCategory Methods new :: MonadIO m => (ManagedPtr DebugCategory -> DebugCategory) -> [AttrOp DebugCategory tag] -> m DebugCategory # | |
newZeroDebugCategory :: MonadIO m => m DebugCategory Source #
Construct a DebugCategory struct initialized to zero.
noDebugCategory :: Maybe DebugCategory Source #
A convenience alias for Nothing :: Maybe DebugCategory.
Methods
free
Arguments
| :: (HasCallStack, MonadIO m) | |
| => DebugCategory |
|
| -> m () |
Removes and frees the category and all associated resources.
getColor
debugCategoryGetColor Source #
Arguments
| :: (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
debugCategoryGetDescription Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => DebugCategory |
|
| -> m Text | Returns: the description of the category. |
Returns the description of a debug category.
getName
Arguments
| :: (HasCallStack, MonadIO m) | |
| => DebugCategory |
|
| -> m Text | Returns: the name of the category. |
Returns the name of a debug category.
getThreshold
debugCategoryGetThreshold Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => DebugCategory |
|
| -> m DebugLevel | Returns: the |
Returns the threshold of a DebugCategory.
resetThreshold
debugCategoryResetThreshold Source #
Arguments
| :: (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
debugCategorySetThreshold Source #
Arguments
| :: (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. > 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).