pw_framebuffer: Remove Pen/Transparent color state

Move the Framebuffer to be a simple owner of the actual framebuffer
pointer along with basic metadata (width, height, etc.). It keeps
basic pixel set/get methods, but drawing state will be managed by
other objects responsible for rendering into the framebuffer. This
means that pw_draw can no longer rely on the fact that the
Framebuffer has a pen color state. This resulted in all pw_draw
functions having an explicit color argument - or more precisely
removing those with no color parameter.

Previously Framebuffer had a concept of a "transparent color"
which was used to indicate an invalid color. Framebuffer::GetPixel()
would return the transparent color if the requested pixel
coordinates were out of bounds. This change modifies GetPixel()
to return a boolean to indicate a valid returned color.

This is to support displays with multiple framebuffers. In this
scenario the drawing state should be maintained elsewhere.
Additionally the Framebuffer object should be small to be
efficiently passed as a stack variable.

Change-Id: I74e5feeac20330d4d07093abb10f6a38df1b3fa3
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/experimental/+/114710
Commit-Queue: Chris Mumford <cmumford@google.com>
Reviewed-by: Erik Gilling <konkers@google.com>
14 files changed
tree: 9db067e9b209c044424f13affa333985765884d6
  1. applications/
  2. build_overrides/
  3. infra/
  4. pw_board_led/
  5. pw_board_led_arduino/
  6. pw_board_led_host/
  7. pw_board_led_pico/
  8. pw_board_led_stm32cube/
  9. pw_board_led_stm32f429i_disc1/
  10. pw_digital_io_pico/
  11. pw_digital_io_stm32cube/
  12. pw_display_driver/
  13. pw_display_driver_ili9341/
  14. pw_graphics/
  15. pw_spi_pico/
  16. pw_spi_stm32f429i_disc1_stm32cube/
  17. pw_spin_delay/
  18. pw_spin_delay_arduino/
  19. pw_spin_delay_host/
  20. pw_spin_delay_pico/
  21. pw_spin_delay_stm32cube/
  22. pw_spin_delay_stm32f429i_disc1/
  23. targets/
  24. third_party/
  25. tools/
  26. .gitattributes
  27. .gitignore
  28. .gitmodules
  29. .gn
  30. activate.bat
  31. banner.txt
  32. bootstrap.bat
  33. bootstrap.sh
  34. BUILD.gn
  35. BUILDCONFIG.gn
  36. env_setup.json
  37. navbar.md
  38. OWNERS
  39. PW_PLUGINS
  40. README.md
README.md

Pigweed Experimental

This repository contains experimental pigweed modules.

Repository setup

Clone this repo with --recursive to get all required submodules.

git clone --recursive https://pigweed.googlesource.com/pigweed/experimental

This will pull the Pigweed source repository into third_party/pigweed. If you already cloned but forgot to --recursive run git submodule update --init to pull all submodules.

pw_graphics

The //pw_graphics folder contains some libraries for drawing to an RGB565 framebuffer and displaying it on various platforms.

The demo applications that make use of these libraries are:

Build instructions

First time setup:

git clone --recursive https://pigweed.googlesource.com/pigweed/experimental
cd experimental
. ./bootstrap.sh
pw package install imgui
pw package install glfw
pw package install stm32cube_f4
pw package install pico_sdk

STM32F429-DISC1

Compile:

gn gen out --export-compile-commands --args="
  dir_pw_third_party_stm32cube_f4=\"$PW_PROJECT_ROOT/environment/packages/stm32cube_f4\"
"
ninja -C out

Flash:

openocd -f third_party/pigweed/targets/stm32f429i_disc1/py/stm32f429i_disc1_utils/openocd_stm32f4xx.cfg -c "program out/stm32f429i_disc1_stm32cube_debug/obj/applications/terminal_display/bin/terminal_demo.elf verify reset exit"

Linux, Windows or Mac

Compile:

gn gen out --export-compile-commands --args="
  dir_pw_third_party_imgui=\"$PW_PROJECT_ROOT/environment/packages/imgui\"
  dir_pw_third_party_glfw=\"$PW_PROJECT_ROOT/environment/packages/glfw\"
"
ninja -C out

Run:

out/host_debug/obj/applications/terminal_display/bin/terminal_demo

Raspberry Pi Pico Connected to an external SPI display

Working displays:

Compile:

gn gen out --export-compile-commands --args="
  PICO_SRC_DIR=\"$PW_PROJECT_ROOT/environment/packages/pico_sdk\"
"
ninja -C out

Flash:

  • Using a uf2 file:

    ./out/host_debug/obj/targets/rp2040/bin/elf2uf2 ./out/rp2040/obj/applications/terminal_display/bin/terminal_demo.elf ./out/rp2040/obj/applications/terminal_display/bin/terminal_demo.uf2
    

    Copy ./out/rp2040/obj/applications/terminal_display/bin/terminal_demo.uf2 to your Pi Pico.

  • Using a Pico Probe and openocd:

    This requires installing the Raspberry Pi foundation's OpenOCD fork for the Pico probe. More details including how to connect the two Pico boards is available at Raspberry Pi Pico and RP2040 - C/C++ Part 2: Debugging with VS Code

    Install RaspberryPi's OpenOCD Fork:

    git clone https://github.com/raspberrypi/openocd.git \
      --branch picoprobe \
      --depth=1 \
      --no-single-branch \
      openocd-picoprobe
    
    cd openocd-picoprobe
    
    ./bootstrap
    ./configure --enable-picoprobe --prefix=$HOME/apps/openocd --disable-werror
    make -j2
    make install
    

    Setup udev rules (Linux only):

    cat <<EOF > 49-picoprobe.rules
    SUBSYSTEMS=="usb", ATTRS{idVendor}=="2e8a", ATTRS{idProduct}=="0004", MODE:="0666"
    KERNEL=="ttyACM*", ATTRS{idVendor}=="2e8a", ATTRS{idProduct}=="0004", MODE:="0666"
    EOF
    sudo cp 49-picoprobe.rules /usr/lib/udev/rules.d/49-picoprobe.rules
    sudo udevadm control --reload-rules
    

    Flash the Pico:

    ~/apps/openocd/bin/openocd -f ~/apps/openocd/share/openocd/scripts/interface/picoprobe.cfg -f ~/apps/openocd/share/openocd/scripts/target/rp2040.cfg -c 'program out/rp2040/obj/applications/terminal_display/bin/terminal_demo.elf verify reset exit'