Crate firefly_rust

source ·
Expand description

§firefly-rust

Rust SDK for making Firefly Zero games.

§Installation

cargo add firefly_rust

§Cargo features

  • std: required if you don’t build your project with #![no_std]. It will remove from the crate the custom panic handler to avoid conflicts with the standard library.
  • alloc: required if you want to use FileBuf. Allows the crate to do memory allocations. If you enable alloc but not std, you have to also provide a global allocator. We recommend using talc.
  • sudo: required if you want to use sudo module. Enables privileged access to the device.
  • nalgebra_support: can be activated if you use nalgebra. Enables type conversion to and from nalgebra vectors.

§License

MIT License. You can do whatever you want with the SDK, modify it, embed into any apps and games. Have fun!

Re-exports§

Modules§

  • data
    Functions for accessing files in the app data dir.
  • graphics
    Draw shapes, images, and text on the screen.
  • math
    A few useful math (trigonometric) functions for f32.
  • rom
    Functions for accessing files in the app ROM.
  • shapes
    Structs for working with shapes as values.
  • sudo
    Functions available only to privileged apps.

Structs§

  • Buttons
    State of the buttons.
  • DPad
    DPad-like representation of the Pad.
  • File
    A file loaded from ROM or data dir into the memory.
  • FileBuf
    Like File but owns the buffer.
  • Font
    A loaded font file.
  • Image
    A loaded image file.
  • Pad
    A finger position on the touch pad.
  • SubImage
    A subregion of an image. Constructed using Image::sub.

Enums§

Functions§