snippets.json

{
  "character_table": {
    "brief.md": "Defines mappings between UTF-8 code point sequences (characters) and their visual representations (pixmaps).\n\n## Use Cases\n\n- **Character-to-glyph mapping** - Associates text characters, including single utf8 code points, ligatures, and grapheme clusters, with their pixmap representation.\n",
    "configurations": {
      "brief": {
        "constant_code_point_count.md": "The exact code point length of all records' `code_points` fields in this table."
      },
      "condition": {
        "constant_code_point_count.md": "If `use_constant_code_point_count` is enabled."
      },
      "flag": {
        "use_constant_code_point_count.md": "All characters in this table have the same number of code points."
      }
    },
    "links": {
      "brief": {
        "pixmap_tables.md": "Pixmap Tables supplying the pixmaps each record may map to."
      },
      "condition": {
        "pixmap_tables.md": "If `link_pixmap_tables` is enabled."
      },
      "flag": {
        "link_pixmap_tables.md": "This table links to any number of Pixmap Tables."
      }
    },
    "modifiers": {
      "brief": {
        "use_advance_x.md": "Each record includes an `advance_x` field specifying horizontal pixel advance after rendering.",
        "use_pixmap_index.md": "Each record includes a `pixmap_index` field to explicitly reference a pixmap by index.",
        "use_pixmap_table_index.md": "Each record includes a `pixmap_table_index` field to specify which linked Pixmap Table to reference."
      },
      "details": {
        "use_advance_x.md": "When disabled, the default advance is the pixmap's width. Letter spacing, if any, is added to the advance value.",
        "use_pixmap_index.md": "When disabled, the pixmap index defaults to match the character record index creating a one to one mapping.",
        "use_pixmap_table_index.md": "When disabled, the renderer searches linked Pixmap Tables in order until finding a valid pixmap at the character's index. The first pixmap linked will have priority over the last."
      }
    },
    "records": {
      "brief": {
        "advance_x.md": "Number of pixels to advance horizontally after rendering this character.",
        "code_points.md": "UTF-8 encoded code point sequence, null-terminated unless `constant_code_point_count` is set.",
        "pixmap_index.md": "Index of the pixmap within the referenced Pixmap Tables.",
        "pixmap_table_index.md": "Index of the specific Pixmap Table to use for this character."
      },
      "condition": {
        "advance_x.md": "If `use_advance_x` modifier is enabled.",
        "code_points.md": "Always present.",
        "pixmap_index.md": "If `use_pixmap_index` modifier is enabled.",
        "pixmap_table_index.md": "If `use_pixmap_table_index` modifier is enabled."
      }
    }
  },
  "color_table": {
    "brief.md": "Stores RGBA color values that can be referenced by pixmap data.\n\n## Use Cases\n\n- **Pixmap palettes** - When linked to a Pixmap Table, provides the color palette for indexed pixel data.\n- **Color storage** - Can store color sets independently for other purposes.",
    "configurations": {
      "brief": {
        "constant_alpha.md": "The alpha channel value applied to all colors in this table."
      },
      "condition": {
        "constant_alpha.md": "If `use_constant_alpha` is enabled."
      },
      "flag": {
        "use_constant_alpha.md": "All colors in this table share the same alpha value."
      }
    },
    "modifiers": {
      "brief": {
        "use_color_type.md": "Each record includes a `color_type` field indicating the color mutability type."
      },
      "details": {
        "use_color_type.md": "When disabled, the default color type is dynamic. The rendering engine may change the RGBA color to support features such as, but not limited to; text color, and/or palette theming."
      }
    },
    "records": {
      "brief": {
        "blue.md": "Blue channel value.",
        "color_type.md": "Color Type value (0 = Dynamic, 1 = Absolute).",
        "custom_alpha.md": "Alpha channel value (0 = fully transparent, 255 = fully opaque).",
        "green.md": "Green channel value.",
        "red.md": "Red channel value."
      },
      "condition": {
        "blue.md": "Always present",
        "color_type.md": "If `use_color_type` modifier is enabled.",
        "custom_alpha.md": "If `constant_alpha` configuration is **not** set",
        "green.md": "Always present",
        "red.md": "Always present"
      }
    }
  },
  "data_types": {
    "ColorType": {
      "Absolute.md": "The renderer should render this color exactly as specified, without substitution.\n",
      "Dynamic.md": "The renderer may substitute this color to support features such as text color or palette theming.\n"
    },
    "ColorType.md": "Distinguishes whether a color should be treated as fixed or can be themed and recolored by the renderer.\n",
    "FontType": {
      "Bold.md": "The bold-weight variant of a font family.\n",
      "Italic.md": "The italic or oblique variant of a font family.\n",
      "Regular.md": "The default variant of a font family.\n"
    },
    "FontType.md": "Bit flags describing the typographic style a font represents. No flags set means Regular.\n",
    "String.md": "A null-terminated (`0x00`), UTF-8 encoded byte string of any length. Unless otherwise specified.\n",
    "Vec.md": "`u8` length byte followed by that many entries of type `T`. Unless otherwise specified.",
    "Version": {
      "FV0.md": "The latest SimplePixelFont format version.\n"
    },
    "Version.md": "Identifies which version of the SimplePixelFont binary layout a file was parsed from or should be serialized as.\n",
    "has_field.md": "Non-zero if the corresponding optional field is present; zero if it should be treated as absent (`None`).\n",
    "u8.md": "A single byte representing a number from 0 to 255 unless otherwise specified."
  },
  "errors": {
    "conversion_null_error.md": "A Rust string being converted to a C string contained an interior null byte.\n",
    "conversion_utf8_error.md": "A C string being converted to a Rust string was not valid UTF-8.\n",
    "invalid_pixmap_data.md": "A pixmap's data did not fit the byte layout implied by its width, height, and bits per pixel, or exceeded the maximum value allowed by a compact-encoded partial byte.\n",
    "invalid_signature.md": "The first four bytes did not match the SimplePixelFont file signature.\n",
    "ok.md": "The operation completed successfully.\n",
    "static_vector_too_large.md": "A `Vec` field, such as a table's records or a set of link indexes, held more than 255 entries, which cannot be represented by this format's single-byte length prefixes.\n",
    "unexpected_end_of_file.md": "The byte buffer ended before a complete field, record, or table could be read.\n",
    "unsupported_color_type.md": "A record's color type byte did not correspond to any known `ColorType` variant.\n",
    "unsupported_font_type.md": "A font record's font type byte did not correspond to any known `FontType` variant.\n",
    "unsupported_table_identifier.md": "A table's identifier byte did not correspond to any known table type.\n",
    "unsupported_version.md": "The file's version byte did not correspond to any known `Version` variant.\n"
  },
  "font_table": {
    "brief.md": "Groups Character Tables into named fonts and carries the metadata to identify them.\n \n## Use Cases\n \n- **Sub-font grouping** - A single file can carry several related fonts, such as Regular, Bold, and Italic, each pointing at its own Character Tables.",
    "links": {
      "brief": {
        "character_tables.md": "Characters Tables supplying the set of characters each record can include."
      },
      "condition": {
        "character_tables.md": "If `link_character_tables` is enabled."
      },
      "flag": {
        "link_character_tables.md": "This table links to any number of Character Tables."
      }
    },
    "records": {
      "brief": {
        "author.md": "Author, manufacturer, or credits for the font.",
        "font_type.md": "Style of this font (0 = Regular, 1 = Bold, 2 = Italic).",
        "linked_character_table_indexes.md": "Length byte followed by that many Character Table indices this font may access and use.",
        "name.md": "Human-readable font name.",
        "version.md": "Revision number of this font,"
      },
      "condition": {
        "author.md": "Always present.",
        "font_type.md": "Always present.",
        "linked_character_table_indexes.md": "Always present.",
        "name.md": "Always present.",
        "version.md": "Always present."
      }
    }
  },
  "phrase": {
    "reserved.md": "Reserved for future use."
  },
  "pixmap_table": {
    "brief.md": "Stores glyph data as collections of pixels within pixmaps, representing the visual appearance of a character.\n\n## Use Cases\n\n- **Glyph storage** - Contains the pixmap images for font characters\n",
    "configurations": {
      "brief": {
        "constant_bits_per_pixel.md": "The bits per pixel shared by all pixmaps in this table (only 1-8 supported).",
        "constant_height.md": "The height in pixels shared by all pixmaps in this table.",
        "constant_width.md": "The width in pixels shared by all pixmaps in this table."
      },
      "condition": {
        "constant_bits_per_pixel.md": "If `use_constant_bits_per_pixel` is enabled",
        "constant_height.md": "If `use_constant_height` is enabled.",
        "constant_width.md": "If `use_constant_width` is enabled."
      },
      "flag": {
        "use_constant_bits_per_pixel.md": "All pixmaps in this table use the same number of bits to represent a pixel.",
        "use_constant_height.md": "All pixmaps in this table share the same height.",
        "use_constant_width.md": "All pixmaps in this table share the same width."
      }
    },
    "links": {
      "brief": {
        "color_tables.md": "Color Tables supplying the colors each record's pixel values map to in this table."
      },
      "condition": {
        "color_tables.md": "If `link_color_tables` is enabled."
      },
      "flag": {
        "link_color_tables.md": "This table links to any number of Color Tables."
      }
    },
    "records": {
      "brief": {
        "custom_bits_per_pixel.md": "Bits used to represent each pixel of this pixmap (only 1-8 supported).",
        "custom_height.md": "Height of this pixmap in pixels.",
        "custom_width.md": "Width of this pixmap in pixels.",
        "data.md": "Packed pixel data as a bit array"
      },
      "condition": {
        "custom_bits_per_pixel.md": "If `use_constant_bits_per_pixel` is not enabled.",
        "custom_height.md": "If `use_constant_height` is not enabled.",
        "custom_width.md": "If `use_constant_width` is not enabled.",
        "data.md": "Always present."
      }
    }
  }
}