status-im
/
Vulkan-Docs
mirror of https://github.com/status-im/Vulkan-Docs.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge misc. tweaks from private repository.

This commit is contained in:
Jon Leech 2016-08-05 05:20:40 -07:00
parent 77e4068b0b
commit 40413b8615
6 changed files with 23 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/specs/vulkan/genspec.py
View File

@ -44,30 +44,23 @@ def buildRelease(branch, label, outdir,
'outdir=' + outdir)
print('git checkout', branch)
print('echo Info: Cleaning spec in', outdir)
print('cd', specDir)
print('rm -rf',
outdir + '/man',
outdir + '/xhtml',
outdir + '/pdf',
outdir + '/vkspec.chunked',
outdir + '/style',
outdir + '/vkspec.html',
outdir + '/styleguide.html',
outdir + '/apispec.html',
outdir + '/apispec.xml',
outdir + '/readme.html',
outdir + '/config',
outdir + '/checks',
'specversion.txt')
# print('echo Info: Cleaning spec in', outdir)
print('(cd ', outdir, '&& rm -rf',
'xhtml chunked pdf',
'man config checks',
'vkspec.html styleguide.html apispec.html apispec.pdf registry.html',
')')
print('echo Info: Generating headers and spec include files')
# print('echo Info: Generating specversion.txt')
print('cd', specDir)
print('rm specversion.txt ; make specversion.txt')
# print('echo Info: Generating headers and spec include files')
print('cd', xmlDir)
print('make OUTDIR=' + outdir, xmlTargets)
print('echo Info: Generating spec')
# print('echo Info: Generating spec')
print('cd', specDir)
print('make specversion.txt')
print('make -j 8 OUTDIR=' + outdir, ' NOTEOPTS="-a implementation-guide"',
specTargets)

2
doc/specs/vulkan/man/VkImageLayout.txt
View File

@ -70,7 +70,7 @@ The type(s) of device access supported by each layout are:
destination image of a transfer command. This layout is valid only for
image subresources of images created with the
ename:VK_IMAGE_USAGE_TRANSFER_DST_BIT usage bit enabled.
include::VK_KHR_swapchain/VkImageLayout_swapchain.txt[]
include::../chapters/VK_KHR_swapchain/VkImageLayout_swapchain.txt[]
For each mechanism of accessing an image in the API, there is a parameter or
structure member that controls the image layout used to access the image.

8
doc/specs/vulkan/man/VkResult.txt
View File

@ -48,7 +48,7 @@ Description
An event is unsignaled
* ename:VK_INCOMPLETE
A return array was too small for the result
include::VK_KHR_swapchain/VkResultSuccessDescriptions_swapchain.txt[]
include::../chapters/VK_KHR_swapchain/VkResultSuccessDescriptions_swapchain.txt[]
[[fundamentals-errorcodes]]
.Error codes
@ -80,9 +80,9 @@ include::VK_KHR_swapchain/VkResultSuccessDescriptions_swapchain.txt[]
* ename:VK_ERROR_FRAGMENTED_POOL
A requested pool allocation has failed due to fragmentation of the
pool's memory.
include::VK_KHR_surface/VkResultErrorDescriptions_surface.txt[]
include::VK_KHR_swapchain/VkResultErrorDescriptions_swapchain.txt[]
include::VK_KHR_display_swapchain/VkResultErrorDescriptions_display_swapchain.txt[]
include::../chapters/VK_KHR_surface/VkResultErrorDescriptions_surface.txt[]
include::../chapters/VK_KHR_swapchain/VkResultErrorDescriptions_swapchain.txt[]
include::../chapters/VK_KHR_display_swapchain/VkResultErrorDescriptions_display_swapchain.txt[]
If a command returns a run time error, it will leave any result pointers
unmodified, unless other behavior is explicitly defined in the specification.

4
doc/specs/vulkan/man/VkWaylandSurfaceCreateInfoKHR.txt
View File

@ -16,7 +16,7 @@ C Specification
The sname:VkWaylandSurfaceCreateInfoKHR structure is defined as:
include::../../api/structs/VkWaylandSurfaceCreateInfoKHR.txt[]
include::../api/structs/VkWaylandSurfaceCreateInfoKHR.txt[]
Members
@ -33,7 +33,7 @@ Members
Description
-----------
include::../../validity/structs/VkWaylandSurfaceCreateInfoKHR.txt[]
include::../validity/structs/VkWaylandSurfaceCreateInfoKHR.txt[]
See Also

4
doc/specs/vulkan/man/vkCreateWaylandSurfaceKHR.txt
View File

@ -16,7 +16,7 @@ C Specification
To create a sname:VkSurfaceKHR object for a Wayland surface, call:
include::../../api/protos/vkCreateWaylandSurfaceKHR.txt[]
include::../api/protos/vkCreateWaylandSurfaceKHR.txt[]
Parameters
@ -36,7 +36,7 @@ Parameters
Description
-----------
include::../../validity/protos/vkCreateWaylandSurfaceKHR.txt[]
include::../validity/protos/vkCreateWaylandSurfaceKHR.txt[]
See Also

4
doc/specs/vulkan/man/vkGetPhysicalDeviceWaylandPresentationSupportKHR.txt
View File

@ -17,7 +17,7 @@ C Specification
To determine whether a queue family of a physical device supports presentation
to a Wayland compositor, call:
include::../../api/protos/vkGetPhysicalDeviceWaylandPresentationSupportKHR.txt[]
include::../api/protos/vkGetPhysicalDeviceWaylandPresentationSupportKHR.txt[]
Parameters
@ -34,7 +34,7 @@ Description
This platform-specific function can: be called prior to creating a surface.
include::../../validity/protos/vkGetPhysicalDeviceWaylandPresentationSupportKHR.txt[]
include::../validity/protos/vkGetPhysicalDeviceWaylandPresentationSupportKHR.txt[]
See Also