Vulkan-Docs/images
Jon Leech 476e3f422d Change log for March 18, 2019 Vulkan 1.1.104 spec update:
* Update release number to 104.

Public Issues:

  * Remove the incorrect line from "`Initial`" to "`Invalid`" state in the
    <<commandbuffer-lifecycle-diagram, Lifecycle of a command buffer>>
    diagram (public issue 881).
  * Add Fuchsia platform to <<boilerplate-wsi-header-table, Window System
    Extensions and Headers>> table (public pull request 933).
  * Change the type of
    slink:VkBufferDeviceAddressCreateInfoEXT::pname:deviceAddress from
    basetype:VkDeviceSize to basetype:VkDeviceAddress. These are both
    typedefs of code:uint64_t, so it is an ABI-compatible change (public
    issue 934).

Internal Issues:

  * Remove generated header files and update the CI tests to build a copy of
    the headers for use by the hpp-generate / hpp-compile CI stages. Targets
    to generate the headers will not be removed, but keeping these generated
    files in the repository increased the frequency of conflicts between
    branches when merging to master (internal issue 745).
  * Reword "`undefined: behavior if *action*" to "`must: not do *action*`"
    in the places the old terminology was used, and add a new
    <<writing-undefined, Describing Undefined Behavior>> section of the
    style guide to explain how to write such language in the future
    (internal issue 1579).
  * Move almost all Python scripts into the toplevel `scripts/` directory.
    Apply extensive internal edits to clean up and simplify the scripts, and
    try to follow PEP8 guidelines. Generalize the scripts with the use of a
    Conventions object controlling many aspects of output generation, to
    enable their use in other Khronos projects with similar requirements.
    Autogenerate extension interface refpages (these are experimental and
    may be retired going forward).

New Extensions:

  * `VK_AMD_display_native_hdr`
  * `VK_EXT_full_screen_exclusive` (internal issue 1439)
  * `VK_EXT_host_query_reset`
  * `VK_EXT_pipeline_creation_feedback` (internal issue 1560)
  * `VK_KHR_surface_protected_capabilities` (internal issue 1520)
2019-03-17 06:05:46 -07:00
..
README.adoc Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
accelstruct.svg Change log for September 19, 2018 Vulkan 1.1.85 spec update: 2018-09-15 18:35:16 -07:00
base_image_sample_grid.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
chromasamples_420_xcosited_ycosited.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
chromasamples_420_xcosited_ymidpoint.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
chromasamples_420_xmidpoint_ycosited.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
chromasamples_420_xmidpoint_ymidpoint.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
chromasamples_422_cosited.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
chromasamples_422_midpoint.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
commandbuffer_lifecycle.svg Change log for March 18, 2019 Vulkan 1.1.104 spec update: 2019-03-17 06:05:46 -07:00
fragment_mask.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
innerquad.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
innertri.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
non_strict_lines.svg Change log for July 1, 2018 Vulkan 1.1.79 spec update: 2018-07-01 21:26:49 -07:00
pipeline.svg Change log for November 12, 2018 Vulkan 1.1.92 spec update: 2018-11-12 04:40:40 -08:00
pipelinemesh.svg Change log for November 12, 2018 Vulkan 1.1.92 spec update: 2018-11-12 04:40:40 -08:00
primitive_topology_key_adjacency_edge.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_key_edge.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_key_provoking_vertex.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_key_vertex.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_key_vertex_number.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_key_winding_order.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_line_list.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_line_list_with_adjacency.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_line_strip.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_line_strip_with_adjacency.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_point_list.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_triangle_fan.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_triangle_list.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_triangle_list_with_adjacency.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_triangle_strip.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
primitive_topology_triangle_strip_with_adjacency.svg Change log for March 3, 2019 Vulkan 1.1.102 spec update: 2019-03-03 21:05:48 -08:00
raypipe.svg Change log for February 3, 2019 Vulkan 1.1.99 spec update: 2019-02-04 01:26:23 -08:00
sample_count_1.svg Change log for August 13, 2018 Vulkan 1.1.83 spec update: 2018-08-13 06:23:03 -07:00
sample_count_2.svg Change log for August 13, 2018 Vulkan 1.1.83 spec update: 2018-08-13 06:23:03 -07:00
sample_count_4.svg Change log for August 13, 2018 Vulkan 1.1.83 spec update: 2018-08-13 06:23:03 -07:00
sample_count_8.svg Change log for August 13, 2018 Vulkan 1.1.83 spec update: 2018-08-13 06:23:03 -07:00
sample_count_16.svg Change log for August 13, 2018 Vulkan 1.1.83 spec update: 2018-08-13 06:23:03 -07:00
sparseimage.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
sparseimage_alignedmipsize.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
sparseimage_alignedmipsize_singlemiptail.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
sparseimage_multiaspect.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
sparseimage_singlemiptail.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
tessparam.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
tessparamUL.svg Change log for March 5, 2018 Vulkan 1.1.72 spec update: 2018-04-05 04:24:56 -07:00
vulkantexture0-corner-alternative-a-ll.svg Change log for February 3, 2019 Vulkan 1.1.99 spec update: 2019-02-04 01:26:23 -08:00
vulkantexture0-ll.svg Change log for February 3, 2019 Vulkan 1.1.99 spec update: 2019-02-04 01:26:23 -08:00
vulkantexture0.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vulkantexture1-ll.svg Change log for February 3, 2019 Vulkan 1.1.99 spec update: 2019-02-04 01:26:23 -08:00
vulkantexture1.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vulkantexture2-ll.svg Change log for February 3, 2019 Vulkan 1.1.99 spec update: 2019-02-04 01:26:23 -08:00
vulkantexture2.svg Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00

README.adoc

= Diagrams

Diagrams in this folder have been created with Inkscape, using a restricted
color palette (white, black, 50% gray and pure red), one choice of dotted
vs. solid lines, and only two text sizes (10 and 12) using the generic
"sans serif" font family.

Size 10 fonts should only be used for incidental text for labelling in the
middle of the diagram as an identifying mark (e.g. an example sample point);
prefer size 12 fonts wherever possible.
Smaller sizes are unreadable at default zoom, and larger sizes stick out and
are jarring within the context of the specification.

All diagrams are sized 1:1 so that no additional rescaling is required in
the Specification, which would affect the font sizes.

If adding any new diagrams, please try to maintain consistency with the rest
of these diagrams in order to aid consistency and readability of the Vulkan
specification.
Inkscape does not need to be used, but is recommended as a powerful free
tool for generating vector diagrams, and is known to generate diagrams
compatible with the rest of the Vulkan toolchain.
If using other tools, please ensure that the diagram renders correctly in
popular browsers and in the PDF generation path for the specification.



== UTF-8 Characters

At the moment, the PDF conversion path only supports the Windows-1252
character set, as we are currently using the standard fonts built into every
PDF viewer - such that we don't have to embed a different font.
Unfortunately these only support Windows-1252, which is a highly limited
character set.

As such, characters not in that set will not display properly when present
in an SVG, and will fire a warning when building the PDF.
Luckily, Inkscape has an "Object to path" function built in, which will
convert text to a raw path, allowing these characters to be supported.

Please ensure that you build the PDF before submitting any new images,
particularly with non-standard characters, in order to catch such errors.