GI.Gst.Structs.DebugCategory

This is the struct that describes the categories. Once initialized with GST_DEBUG_CATEGORY_INIT, its values can't be changed anymore.

Exported types

newtype DebugCategory

Memory-managed wrapper type.

Constructors

DebugCategory (ManagedPtr DebugCategory)

Instances

Eq DebugCategory

Defined in GI.Gst.Structs.DebugCategory

Methods

(==) :: DebugCategory -> DebugCategory -> Bool

(/=) :: DebugCategory -> DebugCategory -> Bool

BoxedPtr DebugCategory

Defined in GI.Gst.Structs.DebugCategory

Methods

boxedPtrCopy :: DebugCategory -> IO DebugCategory

boxedPtrFree :: DebugCategory -> IO ()

CallocPtr DebugCategory

Defined in GI.Gst.Structs.DebugCategory

Methods

boxedPtrCalloc :: IO (Ptr DebugCategory)

ManagedPtrNewtype DebugCategory

Defined in GI.Gst.Structs.DebugCategory

Methods

toManagedPtr :: DebugCategory -> ManagedPtr DebugCategory

tag ~ 'AttrSet => Constructible DebugCategory tag

Defined in GI.Gst.Structs.DebugCategory

Methods

new :: MonadIO m => (ManagedPtr DebugCategory -> DebugCategory) -> [AttrOp DebugCategory tag] -> m DebugCategory

newZeroDebugCategory :: MonadIO m => m DebugCategory

Construct a DebugCategory struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

free, resetThreshold.

Getters

getColor, getDescription, getName, getThreshold.

Setters

setThreshold.

free

debugCategoryFree

Arguments

:: (HasCallStack, MonadIO m)

=> DebugCategory

category: DebugCategory to free.

-> m ()

Deprecated: This function can easily cause memory corruption, don't use it.

Removes and frees the category and all associated resources.

getColor

debugCategoryGetColor

Arguments

:: (HasCallStack, MonadIO m)

=> DebugCategory

category: a DebugCategory to get the color of.

-> m Word32

Returns: the color of the category.

Returns the color of a debug category used when printing output in this category.

getDescription

debugCategoryGetDescription

Arguments

:: (HasCallStack, MonadIO m)

=> DebugCategory

category: a DebugCategory to get the description of.

-> m Text

Returns: the description of the category.

Returns the description of a debug category.

getName

debugCategoryGetName

Arguments

:: (HasCallStack, MonadIO m)

=> DebugCategory

category: a DebugCategory to get name of.

-> m Text

Returns: the name of the category.

Returns the name of a debug category.

getThreshold

debugCategoryGetThreshold

Arguments

:: (HasCallStack, MonadIO m)

=> DebugCategory

category: a DebugCategory to get threshold of.

-> m DebugLevel

Returns: the DebugLevel that is used as threshold.

Returns the threshold of a DebugCategory.

resetThreshold

debugCategoryResetThreshold

Arguments

:: (HasCallStack, MonadIO m)

=> DebugCategory

category: a DebugCategory to reset threshold of.

-> 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

Arguments

:: (HasCallStack, MonadIO m)

=> DebugCategory

category: a DebugCategory to set threshold of.

-> DebugLevel

level: the DebugLevel threshold to set.

-> 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).