README.adoc
1= Diagrams
2
3Diagrams in this folder have been created with Inkscape, using a restricted
4color palette (white, black, 50% gray and pure red), one choice of dotted
5vs. solid lines, and only two text sizes (10 and 12) using the generic
6"sans serif" font family.
7
8Size 10 fonts should only be used for incidental text for labelling in the
9middle of the diagram as an identifying mark (e.g. an example sample point);
10prefer size 12 fonts wherever possible.
11Smaller sizes are unreadable at default zoom, and larger sizes stick out and
12are jarring within the context of the specification.
13
14All diagrams are sized 1:1 so that no additional rescaling is required in
15the Specification, which would affect the font sizes.
16
17If adding any new diagrams, please try to maintain consistency with the rest
18of these diagrams in order to aid consistency and readability of the Vulkan
19specification.
20Inkscape does not need to be used, but is recommended as a powerful free
21tool for generating vector diagrams, and is known to generate diagrams
22compatible with the rest of the Vulkan toolchain.
23If using other tools, please ensure that the diagram renders correctly in
24popular browsers and in the PDF generation path for the specification.
25
26
27
28== UTF-8 Characters
29
30At the moment, the PDF conversion path only supports the Windows-1252
31character set, as we are currently using the standard fonts built into every
32PDF viewer - such that we don't have to embed a different font.
33Unfortunately these only support Windows-1252, which is a highly limited
34character set.
35
36As such, characters not in that set will not display properly when present
37in an SVG, and will fire a warning when building the PDF.
38Luckily, Inkscape has an "Object to path" function built in, which will
39convert text to a raw path, allowing these characters to be supported.
40
41Please ensure that you build the PDF before submitting any new images,
42particularly with non-standard characters, in order to catch such errors.
43