xref: /aosp_15_r20/external/pigweed/pw_display/api.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985) 
1.. _module-pw_display-api:
2
3=============
4API reference
5=============
6.. pigweed-module-subpage::
7   :name: pw_display
8
9.. _module-pw_display-api-color:
10
11---------
12Color API
13---------
14.. doxygengroup:: pw_display_color
15   :members:
16
17---------------
18Color Constants
19---------------
20
21.. role:: raw-html(raw)
22   :format: html
23
24``pw_display/colors_pico8.h``
25=============================
26.. list-table::
27   :widths: 40 40 20
28   :header-rows: 1
29
30   * - Constant
31     - Color
32     - Hex Value
33   * - ``pw::display::colors::rgb565::pico8::kBlack``
34     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
35       background-color:#000000; color:white;">Black</span>`
36     - ``#000000``
37   * - ``pw::display::colors::rgb565::pico8::kDarkBlue``
38     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
39       background-color:#1d2b53; color:white;">Dark blue</span>`
40     - ``#1d2b53``
41   * - ``pw::display::colors::rgb565::pico8::kDarkPurple``
42     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
43       background-color:#7e2553; color:white;">Dark purple</span>`
44     - ``#7e2553``
45   * - ``pw::display::colors::rgb565::pico8::kDarkGreen``
46     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
47       background-color:#008751; color:white;">Dark green</span>`
48     - ``#008751``
49   * - ``pw::display::colors::rgb565::pico8::kBrown``
50     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
51       background-color:#ab5236; color:white;">Brown</span>`
52     - ``#ab5236``
53   * - ``pw::display::colors::rgb565::pico8::kDarkGray``
54     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
55       background-color:#5f574f; color:white;">Dark gray</span>`
56     - ``#5f574f``
57   * - ``pw::display::colors::rgb565::pico8::kLightGray``
58     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
59       background-color:#c2c3c7; color:black;">Light gray</span>`
60     - ``#c2c3c7``
61   * - ``pw::display::colors::rgb565::pico8::kWhite``
62     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
63       background-color:#fff1e8; color:black;">White</span>`
64     - ``#fff1e8``
65   * - ``pw::display::colors::rgb565::pico8::kRed``
66     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
67       background-color:#ff004d; color:black;">Red</span>`
68     - ``#ff004d``
69   * - ``pw::display::colors::rgb565::pico8::kOrange``
70     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
71       background-color:#ffa300; color:black;">Orange</span>`
72     - ``#ffa300``
73   * - ``pw::display::colors::rgb565::pico8::kYellow``
74     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
75       background-color:#ffec27; color:black;">Yellow</span>`
76     - ``#ffec27``
77   * - ``pw::display::colors::rgb565::pico8::kGreen``
78     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
79       background-color:#00e436; color:black;">Green</span>`
80     - ``#00e436``
81   * - ``pw::display::colors::rgb565::pico8::kBlue``
82     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
83       background-color:#29adff; color:black;">Blue</span>`
84     - ``#29adff``
85   * - ``pw::display::colors::rgb565::pico8::kIndigo``
86     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
87       background-color:#83769c; color:black;">Indigo</span>`
88     - ``#83769c``
89   * - ``pw::display::colors::rgb565::pico8::kPink``
90     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
91       background-color:#ff77a8; color:black;">Pink</span>`
92     - ``#ff77a8``
93   * - ``pw::display::colors::rgb565::pico8::kPeach``
94     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
95       background-color: #ffccaa; color:black;">Peach</span>`
96     - ``#ffccaa``
97
98``pw_display/colors_endesga64.h``
99=================================
100.. list-table::
101   :widths: 40 40 20
102   :header-rows: 1
103
104   * - Constant
105     - Color
106     - Hex Value
107
108   * - ``pw::display::colors::rgb565::e64::kBlood``
109     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
110       background-color: #ff0040;">&nbsp;</span>`
111     - ``#ff0040``
112   * - ``pw::display::colors::rgb565::e64::kBlack0``
113     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
114       background-color: #131313;">&nbsp;</span>`
115     - ``#131313``
116   * - ``pw::display::colors::rgb565::e64::kBlack1``
117     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
118       background-color: #1b1b1b;">&nbsp;</span>`
119     - ``#1b1b1b``
120   * - ``pw::display::colors::rgb565::e64::kGray0``
121     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
122       background-color: #272727;">&nbsp;</span>`
123     - ``#272727``
124   * - ``pw::display::colors::rgb565::e64::kGray1``
125     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
126       background-color: #3d3d3d;">&nbsp;</span>`
127     - ``#3d3d3d``
128   * - ``pw::display::colors::rgb565::e64::kGray2``
129     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
130       background-color: #5d5d5d;">&nbsp;</span>`
131     - ``#5d5d5d``
132   * - ``pw::display::colors::rgb565::e64::kGray3``
133     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
134       background-color: #858585;">&nbsp;</span>`
135     - ``#858585``
136   * - ``pw::display::colors::rgb565::e64::kGray4``
137     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
138       background-color: #b4b4b4;">&nbsp;</span>`
139     - ``#b4b4b4``
140   * - ``pw::display::colors::rgb565::e64::kWhite``
141     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
142       background-color: #ffffff;">&nbsp;</span>`
143     - ``#ffffff``
144   * - ``pw::display::colors::rgb565::e64::kSteel6``
145     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
146       background-color: #c7cfdd;">&nbsp;</span>`
147     - ``#c7cfdd``
148   * - ``pw::display::colors::rgb565::e64::kSteel5``
149     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
150       background-color: #92a1b9;">&nbsp;</span>`
151     - ``#92a1b9``
152   * - ``pw::display::colors::rgb565::e64::kSteel4``
153     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
154       background-color: #657392;">&nbsp;</span>`
155     - ``#657392``
156   * - ``pw::display::colors::rgb565::e64::kSteel3``
157     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
158       background-color: #424c6e;">&nbsp;</span>`
159     - ``#424c6e``
160   * - ``pw::display::colors::rgb565::e64::kSteel2``
161     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
162       background-color: #2a2f4e;">&nbsp;</span>`
163     - ``#2a2f4e``
164   * - ``pw::display::colors::rgb565::e64::kSteel1``
165     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
166       background-color: #1a1932;">&nbsp;</span>`
167     - ``#1a1932``
168   * - ``pw::display::colors::rgb565::e64::kSteel0``
169     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
170       background-color: #0e071b;">&nbsp;</span>`
171     - ``#0e071b``
172   * - ``pw::display::colors::rgb565::e64::kCoffee0``
173     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
174       background-color: #1c121c;">&nbsp;</span>`
175     - ``#1c121c``
176   * - ``pw::display::colors::rgb565::e64::kCoffee1``
177     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
178       background-color: #391f21;">&nbsp;</span>`
179     - ``#391f21``
180   * - ``pw::display::colors::rgb565::e64::kCoffee2``
181     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
182       background-color: #5d2c28;">&nbsp;</span>`
183     - ``#5d2c28``
184   * - ``pw::display::colors::rgb565::e64::kCoffee3``
185     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
186       background-color: #8a4836;">&nbsp;</span>`
187     - ``#8a4836``
188   * - ``pw::display::colors::rgb565::e64::kCoffee4``
189     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
190       background-color: #bf6f4a;">&nbsp;</span>`
191     - ``#bf6f4a``
192   * - ``pw::display::colors::rgb565::e64::kCoffee5``
193     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
194       background-color: #e69c69;">&nbsp;</span>`
195     - ``#e69c69``
196   * - ``pw::display::colors::rgb565::e64::kCoffee6``
197     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
198       background-color: #f6ca9f;">&nbsp;</span>`
199     - ``#f6ca9f``
200   * - ``pw::display::colors::rgb565::e64::kCoffee7``
201     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
202       background-color: #f9e6cf;">&nbsp;</span>`
203     - ``#f9e6cf``
204   * - ``pw::display::colors::rgb565::e64::kOrange3``
205     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
206       background-color: #edab50;">&nbsp;</span>`
207     - ``#edab50``
208   * - ``pw::display::colors::rgb565::e64::kOrange2``
209     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
210       background-color: #e07438;">&nbsp;</span>`
211     - ``#e07438``
212   * - ``pw::display::colors::rgb565::e64::kOrange1``
213     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
214       background-color: #c64524;">&nbsp;</span>`
215     - ``#c64524``
216   * - ``pw::display::colors::rgb565::e64::kOrange0``
217     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
218       background-color: #8e251d;">&nbsp;</span>`
219     - ``#8e251d``
220   * - ``pw::display::colors::rgb565::e64::kBrightOrange0``
221     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
222       background-color: #ff5000;">&nbsp;</span>`
223     - ``#ff5000``
224   * - ``pw::display::colors::rgb565::e64::kBrightOrange1``
225     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
226       background-color: #ed7614;">&nbsp;</span>`
227     - ``#ed7614``
228   * - ``pw::display::colors::rgb565::e64::kBrightOrange2``
229     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
230       background-color: #ffa214;">&nbsp;</span>`
231     - ``#ffa214``
232   * - ``pw::display::colors::rgb565::e64::kYellow0``
233     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
234       background-color: #ffc825;">&nbsp;</span>`
235     - ``#ffc825``
236   * - ``pw::display::colors::rgb565::e64::kYellow1``
237     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
238       background-color: #ffeb57;">&nbsp;</span>`
239     - ``#ffeb57``
240   * - ``pw::display::colors::rgb565::e64::kGreen5``
241     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
242       background-color: #d3fc7e;">&nbsp;</span>`
243     - ``#d3fc7e``
244   * - ``pw::display::colors::rgb565::e64::kGreen4``
245     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
246       background-color: #99e65f;">&nbsp;</span>`
247     - ``#99e65f``
248   * - ``pw::display::colors::rgb565::e64::kGreen3``
249     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
250       background-color: #5ac54f;">&nbsp;</span>`
251     - ``#5ac54f``
252   * - ``pw::display::colors::rgb565::e64::kGreen2``
253     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
254       background-color: #33984b;">&nbsp;</span>`
255     - ``#33984b``
256   * - ``pw::display::colors::rgb565::e64::kGreen1``
257     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
258       background-color: #1e6f50;">&nbsp;</span>`
259     - ``#1e6f50``
260   * - ``pw::display::colors::rgb565::e64::kGreen0``
261     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
262       background-color: #134c4c;">&nbsp;</span>`
263     - ``#134c4c``
264   * - ``pw::display::colors::rgb565::e64::kOcean0``
265     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
266       background-color: #0c2e44;">&nbsp;</span>`
267     - ``#0c2e44``
268   * - ``pw::display::colors::rgb565::e64::kOcean1``
269     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
270       background-color: #00396d;">&nbsp;</span>`
271     - ``#00396d``
272   * - ``pw::display::colors::rgb565::e64::kOcean2``
273     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
274       background-color: #0069aa;">&nbsp;</span>`
275     - ``#0069aa``
276   * - ``pw::display::colors::rgb565::e64::kOcean3``
277     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
278       background-color: #0098dc;">&nbsp;</span>`
279     - ``#0098dc``
280   * - ``pw::display::colors::rgb565::e64::kOcean4``
281     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
282       background-color: #00cdf9;">&nbsp;</span>`
283     - ``#00cdf9``
284   * - ``pw::display::colors::rgb565::e64::kOcean5``
285     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
286       background-color: #0cf1ff;">&nbsp;</span>`
287     - ``#0cf1ff``
288   * - ``pw::display::colors::rgb565::e64::kOcean6``
289     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
290       background-color: #94fdff;">&nbsp;</span>`
291     - ``#94fdff``
292   * - ``pw::display::colors::rgb565::e64::kCandyGrape3``
293     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
294       background-color: #fdd2ed;">&nbsp;</span>`
295     - ``#fdd2ed``
296   * - ``pw::display::colors::rgb565::e64::kCandyGrape2``
297     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
298       background-color: #f389f5;">&nbsp;</span>`
299     - ``#f389f5``
300   * - ``pw::display::colors::rgb565::e64::kCandyGrape1``
301     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
302       background-color: #db3ffd;">&nbsp;</span>`
303     - ``#db3ffd``
304   * - ``pw::display::colors::rgb565::e64::kCandyGrape0``
305     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
306       background-color: #7a09fa;">&nbsp;</span>`
307     - ``#7a09fa``
308   * - ``pw::display::colors::rgb565::e64::kRoyalBlue2``
309     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
310       background-color: #3003d9;">&nbsp;</span>`
311     - ``#3003d9``
312   * - ``pw::display::colors::rgb565::e64::kRoyalBlue1``
313     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
314       background-color: #0c0293;">&nbsp;</span>`
315     - ``#0c0293``
316   * - ``pw::display::colors::rgb565::e64::kRoyalBlue0``
317     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
318       background-color: #03193f;">&nbsp;</span>`
319     - ``#03193f``
320   * - ``pw::display::colors::rgb565::e64::kPurple0``
321     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
322       background-color: #3b1443;">&nbsp;</span>`
323     - ``#3b1443``
324   * - ``pw::display::colors::rgb565::e64::kPurple1``
325     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
326       background-color: #622461;">&nbsp;</span>`
327     - ``#622461``
328   * - ``pw::display::colors::rgb565::e64::kPurple2``
329     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
330       background-color: #93388f;">&nbsp;</span>`
331     - ``#93388f``
332   * - ``pw::display::colors::rgb565::e64::kPurple3``
333     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
334       background-color: #ca52c9;">&nbsp;</span>`
335     - ``#ca52c9``
336   * - ``pw::display::colors::rgb565::e64::kSalmon0``
337     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
338       background-color: #c85086;">&nbsp;</span>`
339     - ``#c85086``
340   * - ``pw::display::colors::rgb565::e64::kSalmon1``
341     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
342       background-color: #f68187;">&nbsp;</span>`
343     - ``#f68187``
344   * - ``pw::display::colors::rgb565::e64::kRed4``
345     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
346       background-color: #f5555d;">&nbsp;</span>`
347     - ``#f5555d``
348   * - ``pw::display::colors::rgb565::e64::kRed3``
349     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
350       background-color: #ea323c;">&nbsp;</span>`
351     - ``#ea323c``
352   * - ``pw::display::colors::rgb565::e64::kRed2``
353     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
354       background-color: #c42430;">&nbsp;</span>`
355     - ``#c42430``
356   * - ``pw::display::colors::rgb565::e64::kRed1``
357     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
358       background-color: #891e2b;">&nbsp;</span>`
359     - ``#891e2b``
360   * - ``pw::display::colors::rgb565::e64::kRed0``
361     - :raw-html:`<span class="sd-sphinx-override sd-badge" style="width: 100%;
362       background-color: #571c27;">&nbsp;</span>`
363     - ``#571c27``
364