OSD
 
Component OSD
On-Screen Display
Component Level: High
Methods:
(Methods are user-callable functions/subroutines intended for the component functions control. Please see the Embedded Components page for more information.)
  • Enable - Enable OSD module.

      ANSIC prototype: byte Enable(void)
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode

  • Disable - Disable OSD module.

      ANSIC prototype: byte Disable(void)
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode

  • EnableEvent - Enable events.

      ANSIC prototype: byte EnableEvent(void)
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode

  • DisableEvent - Disable events.

      ANSIC prototype: byte DisableEvent(void)
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode

  • PutChar - Display char at the specified position.

      ANSIC prototype: byte PutChar(word Char, byte Color, bool Font12x16, byte BackColor, byte Row, byte Column)
    • Char:word - Index of the character (from 0 to 383)
    • Color:byte - Color of the character.
    • Font12x16:bool - Width of the character (true = Font size is 12 x 16; false = font size is 16 x 16).
    • BackColor:byte - Backgroud Color of the character.
    • Row:byte - Row of the OSD menu. (from 0 to 14)
    • Column:byte - Column of the OSD menu. (from 0 to 29)
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode
      ERR_RANGE - Parameter is out of range
      ERR_VALUE - Parameter of incorrect value

  • SetRowAttrb - Set character attributes in the row.

      ANSIC prototype: byte SetRowAttrb(byte Row, bool DoubleHeight, bool DoubleWidth, bool Enabled)
    • Row:byte - Row of the OSD menu. (from 0 to 14)
    • DoubleHeight:bool - Display characters height (true = character as double height for this row, false = character as normal height for this row).
    • DoubleWidth:bool - Display characters width (true = character as double width for this row, false = character as normal width for this row).
    • Enabled:bool - Set Enable to enable OSD circuity to display the current row of characters (true = row is enabled, false = row is disabled).
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode
      ERR_RANGE - Parameter is out of range

  • SetWinAttrb - Set attributes for background windows.

      ANSIC prototype: byte SetWinAttrb(byte Window, byte RowStart, byte RowEnd, byte ColumnStart, byte ColumnEnd, byte Color, bool Shadow, bool Enabled, byte ShadowColor, byte ShadowWidth, byte ShadowHeight)
    • Window:byte - Index of the background Window for sets. (from 0 to 3).
    • RowStart:byte - Row start address for this window. (from 0 to 15)
    • RowEnd:byte - Row end address. for this window. (from 0 to 15)
    • ColumnStart:byte - Column start address for this window. (from 0 to 31)
    • ColumnEnd:byte - Column end address for this window. (from 0 to 31)
    • Color:byte - Color of this window.
    • Shadow:bool - Shadow for this window. (true = Shadow on, false = Shadow off)
    • Enabled:bool - Enable this background window. (true = BG window is enabled, false = BG window is disabled).
    • ShadowColor:byte - Shadow color of this window.
    • ShadowWidth:byte - Shadow width. (Width = 2, 4, 6, 8).
    • ShadowHeight:byte - Shadow height. (Height = 2, 4, 6, 8).
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode
      ERR_RANGE - Parameter is out of range

  • SetVertPos - Set vertical starting position on the monitor screen.

      ANSIC prototype: byte SetVertPos(byte Pos)
    • Pos:byte - Vertical position (from 1 to 255). One increment is four horizontal lines for each field.
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode
      ERR_RANGE - Parameter is out of range

  • SetHorizPos - Set horizontal starting position on the monitor screen.

      ANSIC prototype: byte SetHorizPos(byte Pos)
    • Pos:byte - Horizontal position (from 1 to 255). One increment is six dots shift the right on the monitor screen.
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode

  • SetCharHeight - Set character height of all displayed characters

      ANSIC prototype: byte SetCharHeight(byte Height)
    • Height:byte - Character heigh. (from 16 to 93 lines)
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode
      ERR_RANGE - Parameter is out of range

  • SetRowSpacing - Set the spacing between the display rows, in units of horizontal scan lines.

      ANSIC prototype: byte SetRowSpacing(byte RSpace)
    • RSpace:byte - Space between rows. (from 0 to 31 lines)
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode
      ERR_RANGE - Parameter is out of range

  • SetVideoPattern - Set Screen Video Pattern.

      ANSIC prototype: byte SetVideoPattern(byte Color, bool Enabled)
    • Color:byte - Pattern color.
    • Enabled:bool - Enable Screen Video Pattern. (true = Enable the free-running full-screen video pattern, false = Screen vidoe pattern disabled)
    • Return value:byte - Error code, possible codes:
      ERR_OK - OK
      ERR_SPEED - This device does not work in the active speed mode
      ERR_RANGE - Parameter is out of range



Constants of colors of the OSD menu:
Name
Color
clBlack
clGreen
clRed
clYellow
clBlue
clAqua
clFuchsia
clWhite


Note: Some methods can be implemented as macros.