GI.Vips.Structs.Progress

A structure available to eval callbacks giving information on evaluation progress. See Image::eval.

Exported types

newtype Progress

Memory-managed wrapper type.

Constructors

Progress (ManagedPtr Progress)

Instances

Eq Progress

Defined in GI.Vips.Structs.Progress

Methods

(==) :: Progress -> Progress -> Bool

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

BoxedPtr Progress

Defined in GI.Vips.Structs.Progress

Methods

boxedPtrCopy :: Progress -> IO Progress

boxedPtrFree :: Progress -> IO ()

CallocPtr Progress

Defined in GI.Vips.Structs.Progress

Methods

boxedPtrCalloc :: IO (Ptr Progress)

ManagedPtrNewtype Progress

Defined in GI.Vips.Structs.Progress

Methods

toManagedPtr :: Progress -> ManagedPtr Progress

tag ~ 'AttrSet => Constructible Progress tag

Defined in GI.Vips.Structs.Progress

Methods

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

newZeroProgress :: MonadIO m => m Progress

Construct a Progress struct initialized to zero.

Methods

set

progressSet

Arguments

:: (HasCallStack, MonadIO m)

=> Bool

progress: True to enable progress messages

-> m ()

If set, vips will print messages about the progress of computation to stdout. This can also be enabled with the --vips-progress option, or by setting the environment variable VIPS_PROGRESS.

Properties

eta

Estimated seconds of computation left

getProgressEta :: MonadIO m => Progress -> m Int32

Get the value of the “eta” field. When overloading is enabled, this is equivalent to

get progress #eta

setProgressEta :: MonadIO m => Progress -> Int32 -> m ()

Set the value of the “eta” field. When overloading is enabled, this is equivalent to

set progress [ #eta := value ]

npels

Number of pels calculated so far

getProgressNpels :: MonadIO m => Progress -> m Int64

Get the value of the “npels” field. When overloading is enabled, this is equivalent to

get progress #npels

setProgressNpels :: MonadIO m => Progress -> Int64 -> m ()

Set the value of the “npels” field. When overloading is enabled, this is equivalent to

set progress [ #npels := value ]

percent

Percent complete

getProgressPercent :: MonadIO m => Progress -> m Int32

Get the value of the “percent” field. When overloading is enabled, this is equivalent to

get progress #percent

setProgressPercent :: MonadIO m => Progress -> Int32 -> m ()

Set the value of the “percent” field. When overloading is enabled, this is equivalent to

set progress [ #percent := value ]

run

Time we have been running

getProgressRun :: MonadIO m => Progress -> m Int32

Get the value of the “run” field. When overloading is enabled, this is equivalent to

get progress #run

setProgressRun :: MonadIO m => Progress -> Int32 -> m ()

Set the value of the “run” field. When overloading is enabled, this is equivalent to

set progress [ #run := value ]

start

Start time

clearProgressStart :: MonadIO m => Progress -> m ()

Set the value of the “start” field to Nothing. When overloading is enabled, this is equivalent to

clear #start

getProgressStart :: MonadIO m => Progress -> m (Maybe Timer)

Get the value of the “start” field. When overloading is enabled, this is equivalent to

get progress #start

setProgressStart :: MonadIO m => Progress -> Ptr Timer -> m ()

Set the value of the “start” field. When overloading is enabled, this is equivalent to

set progress [ #start := value ]

tpels

Number of pels we expect to calculate

getProgressTpels :: MonadIO m => Progress -> m Int64

Get the value of the “tpels” field. When overloading is enabled, this is equivalent to

get progress #tpels

setProgressTpels :: MonadIO m => Progress -> Int64 -> m ()

Set the value of the “tpels” field. When overloading is enabled, this is equivalent to

set progress [ #tpels := value ]