Skip to content

Commit 002caca

Browse files
The-Nice-OneThe-Nice-One
authored
Merge pull request #5 from SimplePixelFont/registry/update-1784994826
Update snippets registry
2 parents 3b0828e + faeebde commit 002caca

1 file changed

Lines changed: 84 additions & 36 deletions

File tree

‎snippets.json‎

Lines changed: 84 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
"brief.md": "Defines mappings between UTF-8 codepoint sequences (characters) and their visual representations (pixmaps).\n\n## Use Cases\n\n- **Character-to-glyph mapping** - Associates text characters, including single utf8 codepoints, ligatures, and grapheme clusters, with their pixmap representation.\n",
44
"configurations": {
55
"brief": {
6-
"constant_codepoint_count.md": "The exact codepoint length of each `codepoints` field in this table"
6+
"constant_code_point_count.md": "The exact code point length of each `code_points` field in this table"
77
},
88
"condition": {
9-
"constant_codepoint_count.md": "If `use_constant_codepoint_count` is enabled."
9+
"constant_code_point_count.md": "If `use_constant_code_point_count` is enabled."
1010
},
1111
"flag": {
12-
"use_constant_codepoint_count.md": "All characters in this table have the same number of codepoints."
12+
"use_constant_code_point_count.md": "All characters in this table have the same number of code points."
1313
}
1414
},
1515
"links": {
1616
"brief": {
17-
"pixmap_tables.md": "Vector of Pixmap Table indices this character table references."
17+
"pixmap_tables.md": "Length byte followed by that many Pixmap Table indices this character table may reference."
1818
},
1919
"condition": {
2020
"pixmap_tables.md": "If `link_pixmap_tables` is enabled."
@@ -31,90 +31,138 @@
3131
},
3232
"details": {
3333
"use_advance_x.md": "When disabled, the default advance is the pixmap's width. Letter spacing, if any, is added to the advance value.",
34-
"use_pixmap_index.md": "When disabled, the pixmap index defaults to match the character record index (1:1 mapping).",
34+
"use_pixmap_index.md": "When disabled, the pixmap index defaults to match the character record index creating a one to one mapping.",
3535
"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."
3636
}
3737
},
3838
"records": {
3939
"brief": {
4040
"advance_x.md": "Number of pixels to advance horizontally after rendering this character.",
41-
"codepoints.md": "Always present",
42-
"pixmap_index.md": "If `use_pixmap_index` modifier is enabled.",
43-
"pixmap_table_index.md": "If `use_pixmap_table_index` modifier is enabled."
41+
"code_points.md": "UTF-8 encoded code point sequence, null-terminated unless `constant_code_point_count` is set.",
42+
"pixmap_index.md": "Index of the pixmap within the referenced Pixmap Tables.",
43+
"pixmap_table_index.md": "Index of the specific Pixmap Table to use for this character."
4444
},
4545
"condition": {
4646
"advance_x.md": "If `use_advance_x` modifier is enabled.",
47-
"codepoints.md": "UTF-8 encoded codepoint sequence (null-terminated unless `constant_codepoint_count` is set).",
48-
"pixmap_index.md": "Index of the pixmap within the referenced Pixmap Table(s).",
49-
"pixmap_table_index.md": "Index of the specific Pixmap Table to use for this character."
47+
"code_points.md": "Always present",
48+
"pixmap_index.md": "If `use_pixmap_index` modifier is enabled.",
49+
"pixmap_table_index.md": "If `use_pixmap_table_index` modifier is enabled."
5050
}
5151
}
5252
},
5353
"color_table": {
54-
"brief.md": "# color_table table\n\nWrite the documentation content for color_table table here.",
54+
"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.",
5555
"configurations": {
5656
"brief": {
57-
"constant_alpha.md": "# constant_alpha\n\nWrite the documentation content for constant_alpha here."
57+
"constant_alpha.md": "The alpha channel value applied to all colors in this table."
58+
},
59+
"condition": {
60+
"constant_alpha.md": "If `use_constant_alpha` is enabled."
61+
},
62+
"flag": {
63+
"use_constant_alpha.md": "All colors in this table share the same alpha value."
5864
}
5965
},
6066
"modifiers": {
6167
"brief": {
62-
"use_color_type.md": "# use_color_type\n\nWrite the documentation content for use_color_type here."
68+
"use_color_type.md": "Each record includes a `color_type` field indicating the color mutability type."
6369
},
6470
"details": {
65-
"use_color_type.md": "# use_color_type details\n\nWrite the documentation content for use_color_type details here."
71+
"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."
6672
}
6773
},
6874
"records": {
6975
"brief": {
70-
"alpha.md": "# alpha\n\nWrite the documentation content for alpha here.",
71-
"blue.md": "# blue\n\nWrite the documentation content for blue here.",
72-
"color_type.md": "# color_type\n\nWrite the documentation content for color_type here.",
73-
"green.md": "# green\n\nWrite the documentation content for green here.",
74-
"red.md": "# red\n\nWrite the documentation content for red here."
76+
"alpha.md": "Alpha channel value (0 = fully transparent, 255 = fully opaque).",
77+
"blue.md": "Blue channel value.",
78+
"color_type.md": "Color Type value (0 = Dynamic, 1 = Absolute).",
79+
"green.md": "Green channel value.",
80+
"red.md": "Red channel value."
81+
},
82+
"condition": {
83+
"alpha.md": "If `constant_alpha` configuration is **not** set",
84+
"blue.md": "Always present",
85+
"color_type.md": "If `use_color_type` modifier is enabled.",
86+
"green.md": "Always present",
87+
"red.md": "Always present"
7588
}
7689
}
7790
},
7891
"font_table": {
79-
"brief.md": "# font_table table\n\nWrite the documentation content for font_table table here.",
92+
"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.",
8093
"links": {
8194
"brief": {
82-
"character_tables.md": "# character_tables\n\nWrite the documentation content for character_tables here."
95+
"character_tables.md": "Length byte followed by that many Character Table indices this font table may reference."
96+
},
97+
"condition": {
98+
"character_tables.md": "If `link_character_tables` is enabled."
99+
},
100+
"flag": {
101+
"link_character_tables.md": "This table links to one or more Character Tables."
83102
}
84103
},
85104
"records": {
86105
"brief": {
87-
"author.md": "# author\n\nWrite the documentation content for author here.",
88-
"character_table_indexes.md": "# character_table_indexes\n\nWrite the documentation content for character_table_indexes here.",
89-
"font_type.md": "# font_type\n\nWrite the documentation content for font_type here.",
90-
"name.md": "# name\n\nWrite the documentation content for name here.",
91-
"version.md": "# version\n\nWrite the documentation content for version here."
106+
"author.md": "Author, manufacturer, or credits for the font.",
107+
"character_table_indexes.md": "Length byte followed by that many Character Table indices this font may access and use.",
108+
"font_type.md": "Style of this font (0 = Regular, 1 = Bold, 2 = Italic).",
109+
"name.md": "Human-readable font name.",
110+
"version.md": "Revision number of this font,"
111+
},
112+
"condition": {
113+
"author.md": "Always present.",
114+
"character_table_indexes.md": "Always present.",
115+
"font_type.md": "Always present.",
116+
"name.md": "Always present.",
117+
"version.md": "Always present."
92118
}
93119
}
94120
},
95121
"phrase": {
96122
"reserved.md": "Reserved for future use."
97123
},
98124
"pixmap_table": {
99-
"brief.md": "# pixmap_table table\n\nWrite the documentation content for pixmap_table table here.",
125+
"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",
100126
"configurations": {
101127
"brief": {
102-
"constant_bits_per_pixel.md": "# constant_bits_per_pixel\n\nWrite the documentation content for constant_bits_per_pixel here.",
103-
"constant_height.md": "# constant_height\n\nWrite the documentation content for constant_height here.",
104-
"constant_width.md": "# constant_width\n\nWrite the documentation content for constant_width here."
128+
"constant_bits_per_pixel.md": "The bits per pixel shared by all pixmaps in this table (only 1-8 supported).",
129+
"constant_height.md": "The height in pixels shared by all pixmaps in this table.",
130+
"constant_width.md": "The width in pixels shared by all pixmaps in this table."
131+
},
132+
"condition": {
133+
"constant_bits_per_pixel.md": "If `use_constant_bits_per_pixel` is enabled",
134+
"constant_height.md": "If `use_constant_height` is enabled.",
135+
"constant_width.md": "If `use_constant_width` is enabled."
136+
},
137+
"flag": {
138+
"use_constant_bits_per_pixel.md": "All pixmaps in this table use the same number of bits to represent a pixel.",
139+
"use_constant_height.md": "All pixmaps in this table share the same height.",
140+
"use_constant_width.md": "All pixmaps in this table share the same width."
105141
}
106142
},
107143
"links": {
108144
"brief": {
109-
"color_tables.md": "# color_tables\n\nWrite the documentation content for color_tables here."
145+
"color_tables.md": "Length byte followed by that many Color Table indices supplying the palette that pixel values index into."
146+
},
147+
"condition": {
148+
"color_tables.md": "If `link_color_tables` is enabled."
149+
},
150+
"flag": {
151+
"link_color_tables.md": "This table links to one or more Color Tables for palette mapping"
110152
}
111153
},
112154
"records": {
113155
"brief": {
114-
"bits_per_pixel.md": "# bits_per_pixel\n\nWrite the documentation content for bits_per_pixel here.",
115-
"data.md": "# data\n\nWrite the documentation content for data here.",
116-
"height.md": "# height\n\nWrite the documentation content for height here.",
117-
"width.md": "# width\n\nWrite the documentation content for width here."
156+
"bits_per_pixel.md": "Bits used to represent each pixel of this pixmap (only 1-8 supported).",
157+
"data.md": "Packed pixel data as a bit array",
158+
"height.md": "Height of this pixmap in pixels.",
159+
"width.md": "Width of this pixmap in pixels."
160+
},
161+
"condition": {
162+
"bits_per_pixel.md": "If `use_constant_bits_per_pixel` is not enabled.",
163+
"data.md": "Always present.",
164+
"height.md": "If `use_constant_height` is not enabled.",
165+
"width.md": "If `use_constant_width` is not enabled."
118166
}
119167
}
120168
}

0 commit comments

Comments
 (0)