Sensoray 2246 - Manual (Page 47)

Ypos -- start y position
Value -- pointer to text or image file path
board ID if multiple boards installed.
Returns:
0 on success
MID2246_API int SN_OverlayBackgroundColor (int red, int green, int blue, int board)
Set the color used for the background regions
Parameters:
red -- 0 min, 255 max red
green -- 0 min, 255 max green
blue -- 0 min, 255 max blue
board ID if multiple boards installed.
Returns:
0 on success
MID2246_API int SN_MoveOverlay (int WinIndex, int NewX, int NewY, int board)
Change position of an overlay sub-window Does not reload or download the new image
Parameters:
WinIndex -- index of sub-window to move
NewX -- new X position
NewY -- new y position
board ID if multiple boards installed.
Returns:
0 on success, -1 overlay does not exist yet.
MID2246_API int SN_OverlayDelXY (int xpos, int ypos, int board)
Delete an overlay at x,y location. Does not reload or download the new image
Parameters:
xpos -- X position of sub-window to delete
ypos -- y position of sub-window to delete
board ID if multiple boards installed.
Returns:
0 on success, -1 overlay does not exist yet, -2 if that sub-window already unused.
MID2246_API int SN_OverlayDel (int WinIndex, int board)
Delete an overlay at at a given index. Does not reload or download the new image
Parameters:
WinIndex -- index of sub-window to delete
board ID if multiple boards installed.
Returns:
0 on success, -1 overlay does not exist yet.
MID2246_API int SN_UpdateOverlay (int board)
Refresh or update the overlay to the hardware
Parameters:
board ID if multiple boards installed.
47