Difference between revisions of "Event Scope.Overlay"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
(XML Import to change Variable types into Variable Types) |
||
| Line 1: | Line 1: | ||
| − | |||
Sent when the mouse hovers over a scope stream | Sent when the mouse hovers over a scope stream | ||
| Line 7: | Line 6: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''StreamH'' |
:The stream handle | :The stream handle | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''TimeUS'' |
:The -ve offset from now of the time hovered over, in microseconds | :The -ve offset from now of the time hovered over, in microseconds | ||
| − | [[Variable | + | [[Variable Types|FLOAT]] ''UnitValue'' |
:The value pointed to on the scope, from 0 to 1 | :The value pointed to on the scope, from 0 to 1 | ||
| − | [[Variable | + | [[Variable Types|STRING]] ''Info'' |
:The text to display on the overlay | :The text to display on the overlay | ||
:''This parameter is returned back to Flowcode'' | :''This parameter is returned back to Flowcode'' | ||
| − | [[Variable | + | [[Variable Types|LONG]] ''OverlayOffset'' |
:The number of micoseconds to add to the Time for the overlay start | :The number of micoseconds to add to the Time for the overlay start | ||
:''This parameter is returned back to Flowcode'' | :''This parameter is returned back to Flowcode'' | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''OverlaySize'' |
:The number of microseconds of the overlay from its start | :The number of microseconds of the overlay from its start | ||
:''This parameter is returned back to Flowcode'' | :''This parameter is returned back to Flowcode'' | ||
| Line 30: | Line 29: | ||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|ULONG]] |
Non-zero to add the overlay to the stream | Non-zero to add the overlay to the stream | ||
Revision as of 11:09, 10 June 2013
Sent when the mouse hovers over a scope stream
This event is part of the Scope class
Parameters
HANDLE StreamH
- The stream handle
ULONG TimeUS
- The -ve offset from now of the time hovered over, in microseconds
FLOAT UnitValue
- The value pointed to on the scope, from 0 to 1
STRING Info
- The text to display on the overlay
- This parameter is returned back to Flowcode
LONG OverlayOffset
- The number of micoseconds to add to the Time for the overlay start
- This parameter is returned back to Flowcode
ULONG OverlaySize
- The number of microseconds of the overlay from its start
- This parameter is returned back to Flowcode
Return value
ULONG Non-zero to add the overlay to the stream
Detailed description
No additional information
Examples
No additional information
