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