Skip to content

GetPrefRGB.md

Latest commit

 

History

History
49 lines (39 loc) · 1.09 KB

GetPrefRGB.md

File metadata and controls

49 lines (39 loc) · 1.09 KB
Raw

GetPrefRGB

Description

Procedure GetPrefRGB return the RGB color components of the specified preference item. The RGB values are in the range of 0 - 65535.

PROCEDURE GetPrefRGB(
				prefIndex   : INTEGER;
				VAR colorRV : LONGINT;
				VAR colorGV : LONGINT;
				VAR colorBV : LONGINT);
def vs.GetPrefRGB(prefIndex):
    return (colorRV, colorGV, colorBV)

Parameters

Name Type Description
prefIndex INTEGER Preference item constant
colorRV LONGINT Returns RGB color component (red)
colorGV LONGINT Returns RGB color component (green)
colorBV LONGINT Returns RGB color component (blue)

Examples

GetPrefRGB(1, 2, 3, 10);
import vs

# Procedure GetPrefRGB return the RGB color components of the specified
# preference item.
prefIndex = 1

colorRV, colorGV, colorBV = vs.GetPrefRGB(prefIndex)
vs.Message('GetPrefRGB returned: ' + str((colorRV, colorGV, colorBV)))

See Also

SetPrefRGB

Version

Availability: from Vectorworks14.0

Category