Drawing option constants

Modules
	Device name constants
	Opcode constants
	TimerModule

Macros
#define	DRAW_OPT_NORMAL   (0x0000)
#define	DRAW_OPT_CLEAR_WHOLE_SCREEN   (0x0001)
#define	DRAW_OPT_CLEAR_EXCEPT_STATUS_SCREEN   (0x0002)
#define	DRAW_OPT_CLEAR_PIXELS   (0x0004)
#define	DRAW_OPT_CLEAR   (0x0004)
#define	DRAW_OPT_INVERT   (0x0004)
#define	DRAW_OPT_LOGICAL_COPY   (0x0000)
#define	DRAW_OPT_LOGICAL_AND   (0x0008)
#define	DRAW_OPT_LOGICAL_OR   (0x0010)
#define	DRAW_OPT_LOGICAL_XOR   (0x0018)
#define	DRAW_OPT_FILL_SHAPE   (0x0020)
#define	DRAW_OPT_CLEAR_SCREEN_MODES   (0x0003)
#define	DRAW_OPT_LOGICAL_OPERATIONS   (0x0018)
#define	DRAW_OPT_POLYGON_POLYLINE   (0x0400)
#define	DRAW_OPT_CLEAR_LINE   (0x0800)
#define	DRAW_OPT_CLEAR_EOL   (0x1000)

Detailed Description

Constants that are for specifying drawing options in several display module API functions. Bits 0 & 1 (values 0,1,2,3) control screen clearing behaviour (Not within RIC files). Bit 2 (value 4) controls the NOT operation, i.e. draw in white or invert text/graphics. Bits 3 & 4 (values 0,8,16,24) control pixel logical combinations (COPY/AND/OR/XOR). Bit 5 (value 32) controls shape filling, or overrides text/graphic bitmaps with set pixels. These may be ORed together for the full instruction (e.g., DRAW_OPT_NORMAL|DRAW_OPT_LOGICAL_XOR) These operations are resolved into the separate, common parameters defined in 'c_display.iom' before any drawing function is called. Note that when drawing a RIC file, the initial 'DrawingOptions' parameter supplied in the drawing instruction controls screen clearing, but nothing else. The 'CopyOptions' parameter from each instruction in the RIC file then controls graphic operations, but the screen-clearing bits are ignored.

See Also

TextOut(), NumOut(), PointOut(), LineOut(), CircleOut(), RectOut(), PolyOut(), EllipseOut(), FontTextOut(), FontNumOut(), GraphicOut(), GraphicArrayOut()

Warning

These options require the enhanced NBC/NXC firmware

Macro Definition Documentation

#define DRAW_OPT_CLEAR   (0x0004)

Clear pixels while drawing (aka draw in white)

#define DRAW_OPT_CLEAR_EOL   (0x1000)

When drawing text, clear to the end of the line after drawing the text

#define DRAW_OPT_CLEAR_EXCEPT_STATUS_SCREEN   (0x0002)

Clear the screen except for the status line before drawing

#define DRAW_OPT_CLEAR_LINE   (0x0800)

When drawing text, clear the entire line before drawing the text

#define DRAW_OPT_CLEAR_PIXELS   (0x0004)

Clear pixels while drawing (aka draw in white)

#define DRAW_OPT_CLEAR_SCREEN_MODES   (0x0003)

Bit mask for the clear screen modes

#define DRAW_OPT_CLEAR_WHOLE_SCREEN   (0x0001)

Clear the entire screen before drawing

#define DRAW_OPT_FILL_SHAPE   (0x0020)

Fill the shape while drawing (rectangle, circle, ellipses, and polygon)

#define DRAW_OPT_INVERT   (0x0004)

Invert text or graphics

#define DRAW_OPT_LOGICAL_AND   (0x0008)

Draw pixels using a logical AND operation

#define DRAW_OPT_LOGICAL_COPY   (0x0000)

Draw pixels using a logical copy operation

#define DRAW_OPT_LOGICAL_OPERATIONS   (0x0018)

Bit mask for the logical drawing operations

#define DRAW_OPT_LOGICAL_OR   (0x0010)

Draw pixels using a logical OR operation

#define DRAW_OPT_LOGICAL_XOR   (0x0018)

Draw pixels using a logical XOR operation

#define DRAW_OPT_NORMAL   (0x0000)

Normal drawing

#define DRAW_OPT_POLYGON_POLYLINE   (0x0400)

When drawing polygons, do not close (i.e., draw a polyline instead)