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