index :: ui

ui.lcd

black and white bitmap display

available since version: 0.9.7

---

methods:

• clear clear display
  

• draw left moves draw cursor left along x-asis ans draw single pixel
  parameters:
  • [XOFF] x-offset. If omitted: 1
    type: int
    
• draw right moves cursor right along x-asis ans draw single pixel
  parameters:
  • [XOFF] x-offset. If omitted: 1
    type: int
    
• draw up moves draw cursor up along y-asis ans draw single pixel
  parameters:
  • [YOFF] y-offset. If omitted: 1
    type: int
    
• draw down moves draw cursor down along y-asis ans draw single pixel
  parameters:
  • [YOFF] y-offset. If omitted: 1
    type: int
    
• draw set set drawing value
  parameters:
  • VALUE draw pixel value (1: black, 0: white)
    type: bool
    required: True
    

• dump dumps all object info to Pd console window.
  

• invert invert display
  

• pos set UI element position
  parameters:

  • X top left x-coord
    type: float
    required: True
    

  • Y top right y-coord
    type: float
    required: True
    

• set set display content
  parameters:
  • PIXELS pixel values
    type: list
    required: True
    
• set col set column content
  parameters:

  • N column index
    type: int
    required: True
    

  • PIXELS column pixel values
    type: list
    required: True
    

• set cursor set draw cursor point
  parameters:

  • X X-position (from left)
    type: int
    required: True
    

  • Y Y-position (from top)
    type: int
    required: True
    

• set pixel set single pixel
  parameters:

  • X X-position (from left)
    type: int
    required: True
    

  • Y Y-position (from top)
    type: int
    required: True
    

  • VALUE pixel value
    type: bool
    required: True
    

• set row set row content
  parameters:

  • N row index
    type: int
    required: True
    

  • PIXELS row pixel values
    type: list
    required: True
    

properties:

• @send Get/set send destination
  type: symbol
  default: (null)
  

• @receive Get/set receive source
  type: symbol
  default: (null)
  

• @size Get/set element size (width, height pair)
  type: list
  default: 64 64
  

• @pinned Get/set pin mode. if 1 - put element to the lowest level
  type: bool
  default: 0
  

• @background_color Get/set element background color (list of red, green, blue values in 0-1 range)
  type: list
  default: 1 1 1 1
  

• @border_color Get/set border color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.6 0.6 0.6 1
  

• @fontsize Get/set fontsize
  type: int
  range: 4..100
  default: 11
  

• @fontname Get/set fontname
  type: symbol
  enum: Courier, DejaVu, Helvetica, Monaco, Times
  default: Helvetica
  

• @fontweight Get/set font weight
  type: symbol
  enum: normal, bold
  default: normal
  

• @fontslant Get/set font slant
  type: symbol
  enum: roman, italic
  default: roman
  

• @label Get/set label text
  type: symbol
  default: (null)
  

• @label_color Get/set label color in RGB format within 0-1 range, for example: 0.2 0.4 0.1
  type: list
  default: 0 0 0 1
  

• @label_inner Get/set label position (1 - inner, 0 - outer).
  type: bool
  default: 0
  

• @label_align Get/set label horizontal align
  type: symbol
  enum: left, center, right
  default: left
  

• @label_valign Get/set label vertical align
  type: symbol
  enum: top, center, bottom
  default: top
  

• @label_side Get/set label snap side
  type: symbol
  enum: left, top, right, bottom
  default: top
  

• @label_margins Get/set label offset in pixels
  type: list
  default: 0 0
  

• @cols Get/set number of columns
  type: int
  range: 2..128
  default: 8
  

• @rows Get/set number of rows
  type: int
  range: 2..128
  default: 8
  

• @pixels (readonly) Get number of pixels
  type: int
  default: 64
  

inlets:

• command input
  type: control

outlets:

• …
  type: control

keywords:

ui display

Authors: Serge Poltavsky

License: GPL3 or later