API Scope.AddOverlays

From Flowcode Help
Jump to navigationJump to search

<sidebar>API Contents</sidebar> Adds overlay packets to the stream by decoding the stream contents

Class hierarchy

Scope

AddOverlays

Parameters

HANDLE StreamH

The stream that is to be read

LONG TimeUS

The -ve time offset to start the calculation from, in microseconds

ULONG Duration

The duration of the overlay packet

ULONG Baud

The baud to step through each sample with

ULONG Mask

A mask of any bits to include in a decoded packets format value

ULONG Flags

A set of flags to help decode the stream
Typical values for this parameter:
Name Description
Overlay_LSBF Flags least-significant bit first, else most-significant bit first
Overlay_Invert Flags to invert the bits in a packet before calculating the packet value

STRING LabelFmt

A format string to use for labeling packets

ULONG ForeRGBA

A red, green, blue, alpha value for the text and border
The default value for this parameter is: 0x000000C0

ULONG BackRGBA

A red, green, blue, alpha value for the area fill
The default value for this parameter is: 0x40FFE0A0


Return value

This call does not return a value


Detailed description

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Scope.AddOverlays(streamh, timeus, duration, baud, mask, ::Scope.Overlay_LSBF, "labelfmt", forergba, backrgba)

No additional examples