mirror of
https://github.com/KhronosGroup/Vulkan-Hpp.git
synced 2024-10-14 16:32:17 +00:00
docs: Add Doxygen configuration
This commit is contained in:
parent
39ada07dac
commit
e22f73df33
3
.gitmodules
vendored
3
.gitmodules
vendored
@ -13,3 +13,6 @@
|
||||
[submodule "glfw"]
|
||||
path = glfw
|
||||
url = https://github.com/glfw/glfw
|
||||
[submodule "doxygen-awesome-css"]
|
||||
path = doxygen-awesome-css
|
||||
url = https://github.com/jothepro/doxygen-awesome-css.git
|
||||
|
58
Doxyfile
Normal file
58
Doxyfile
Normal file
@ -0,0 +1,58 @@
|
||||
PROJECT_NAME = Vulkan-Hpp
|
||||
SEARCHENGINE = YES
|
||||
GENERATE_TAGFILE = html/tagfile.xml # generate a tag file
|
||||
DOT_IMAGE_FORMAT = svg
|
||||
DOT_TRANSPARENT = YES
|
||||
INTERACTIVE_SVG = YES
|
||||
EXTRACT_ALL = YES
|
||||
RECURSIVE = YES
|
||||
INPUT = vulkan/vulkan.cppm \
|
||||
vulkan/vulkan.hpp \
|
||||
vulkan/vulkan_enums.hpp \
|
||||
vulkan/vulkan_extension_inspection.hpp \
|
||||
vulkan/vulkan_format_traits.hpp \
|
||||
vulkan/vulkan_funcs.hpp \
|
||||
vulkan/vulkan_hash.hpp \
|
||||
vulkan/vulkan_hpp_macros.hpp \
|
||||
vulkan/vulkan_to_string.hpp \
|
||||
vulkan/vulkan_handles.hpp \
|
||||
vulkan/vulkan_video.hpp \
|
||||
vulkan/vulkan_static_assertions.hpp \
|
||||
vulkan/vulkan_raii.hpp \
|
||||
vulkan/vulkan_structs.hpp \
|
||||
vulkan/vulkan_structs.hpp \
|
||||
Vulkan-Headers/include/vulkan/vulkan.h \
|
||||
Vulkan-Headers/include/vulkan/vulkan_core.h \
|
||||
Vulkan-Headers/include/vk_video \
|
||||
README.md \
|
||||
vk_raii_ProgrammingGuide.md \
|
||||
docs/mainpage.dox \
|
||||
docs/Samples.dox \
|
||||
docs/RAII_Samples.dox \
|
||||
samples
|
||||
ENABLE_PREPROCESSING = YES
|
||||
MACRO_EXPANSION = YES
|
||||
EXAMPLE_PATH = . samples
|
||||
|
||||
PREDEFINED += VULKAN_HPP_NAMESPACE="vk"
|
||||
PREDEFINED += VULKAN_HPP_RAII_NAMESPACE="raii"
|
||||
PREDEFINED += VK_ENABLE_BETA_EXTENSIONS="1"
|
||||
|
||||
EXCLUDE = vulkan/vulkan_shared.hpp vulkan/vulkansc_shared.hpp
|
||||
#EXLUDE_PATTERNS = */vulkan/*
|
||||
HAVE_DOT = NO
|
||||
CLASS_GRAPH = NO
|
||||
INHERIT_DOCS = NO
|
||||
INCLUDE_PATH = include Vulkan-Headers/include/
|
||||
REFERENCES_LINK_SOURCE = YES
|
||||
TEMPLATE_RELATIONS = YES
|
||||
SOURCE_BROWSER = YES
|
||||
REFERENCES_RELATION = NO
|
||||
REFERENCED_BY_RELATION = NO
|
||||
|
||||
GENERATE_TREEVIEW = YES
|
||||
DISABLE_INDEX = NO
|
||||
FULL_SIDEBAR = NO
|
||||
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
|
||||
doxygen-awesome-css/doxygen-awesome-sidebar-only.css
|
||||
HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5
|
2
docs/.gitignore
vendored
Normal file
2
docs/.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
html
|
||||
latex
|
256
docs/RAII_Samples.dox
Normal file
256
docs/RAII_Samples.dox
Normal file
@ -0,0 +1,256 @@
|
||||
/**
|
||||
\cond
|
||||
File generate using `python3 docs/generate_samples_dox.py -s RAII_Samples/ -o docs/RAII_Samples.dox`
|
||||
\endcond
|
||||
\page RAII_Samples RAII Samples
|
||||
\subpage RAII_Samples_01_InitInstance
|
||||
|
||||
\subpage RAII_Samples_02_EnumerateDevices
|
||||
|
||||
\subpage RAII_Samples_03_InitDevice
|
||||
|
||||
\subpage RAII_Samples_04_InitCommandBuffer
|
||||
|
||||
\subpage RAII_Samples_05_InitSwapchain
|
||||
|
||||
\subpage RAII_Samples_06_InitDepthBuffer
|
||||
|
||||
\subpage RAII_Samples_07_InitUniformBuffer
|
||||
|
||||
\subpage RAII_Samples_08_InitPipelineLayout
|
||||
|
||||
\subpage RAII_Samples_09_InitDescriptorSet
|
||||
|
||||
\subpage RAII_Samples_10_InitRenderPass
|
||||
|
||||
\subpage RAII_Samples_11_InitShaders
|
||||
|
||||
\subpage RAII_Samples_12_InitFrameBuffers
|
||||
|
||||
\subpage RAII_Samples_13_InitVertexBuffer
|
||||
|
||||
\subpage RAII_Samples_14_InitPipeline
|
||||
|
||||
\subpage RAII_Samples_15_DrawCube
|
||||
|
||||
\subpage RAII_Samples_16_Vulkan_1_1
|
||||
|
||||
\subpage RAII_Samples_CopyBlitImage
|
||||
|
||||
\subpage RAII_Samples_CreateDebugUtilsMessenger
|
||||
|
||||
\subpage RAII_Samples_DebugUtilsObjectName
|
||||
|
||||
\subpage RAII_Samples_DrawTexturedCube
|
||||
|
||||
\subpage RAII_Samples_DynamicUniform
|
||||
|
||||
\subpage RAII_Samples_EnableValidationWithCallback
|
||||
|
||||
\subpage RAII_Samples_EnumerateDevicesAdvanced
|
||||
|
||||
\subpage RAII_Samples_Events
|
||||
|
||||
\subpage RAII_Samples_ImmutableSampler
|
||||
|
||||
\subpage RAII_Samples_InitTexture
|
||||
|
||||
\subpage RAII_Samples_InputAttachment
|
||||
|
||||
\subpage RAII_Samples_InstanceExtensionProperties
|
||||
|
||||
\subpage RAII_Samples_InstanceLayerExtensionProperties
|
||||
|
||||
\subpage RAII_Samples_InstanceLayerProperties
|
||||
|
||||
\subpage RAII_Samples_InstanceVersion
|
||||
|
||||
\subpage RAII_Samples_MultipleSets
|
||||
|
||||
\subpage RAII_Samples_OcclusionQuery
|
||||
|
||||
\subpage RAII_Samples_PhysicalDeviceExtensions
|
||||
|
||||
\subpage RAII_Samples_PhysicalDeviceFeatures
|
||||
|
||||
\subpage RAII_Samples_PhysicalDeviceGroups
|
||||
|
||||
\subpage RAII_Samples_PhysicalDeviceMemoryProperties
|
||||
|
||||
\subpage RAII_Samples_PhysicalDeviceProperties
|
||||
|
||||
\subpage RAII_Samples_PhysicalDeviceQueueFamilyProperties
|
||||
|
||||
\subpage RAII_Samples_PipelineCache
|
||||
|
||||
\subpage RAII_Samples_PipelineDerivative
|
||||
|
||||
\subpage RAII_Samples_PushConstants
|
||||
|
||||
\subpage RAII_Samples_PushDescriptors
|
||||
|
||||
\subpage RAII_Samples_RayTracing
|
||||
|
||||
\subpage RAII_Samples_SecondaryCommandBuffer
|
||||
|
||||
\subpage RAII_Samples_SeparateImageSampler
|
||||
|
||||
\subpage RAII_Samples_SurfaceCapabilities
|
||||
|
||||
\subpage RAII_Samples_SurfaceFormats
|
||||
|
||||
\subpage RAII_Samples_Template
|
||||
|
||||
\subpage RAII_Samples_TexelBuffer
|
||||
|
||||
|
||||
\page RAII_Samples_01_InitInstance 01_InitInstance
|
||||
\include RAII_Samples/01_InitInstance/01_InitInstance.cpp
|
||||
|
||||
\page RAII_Samples_02_EnumerateDevices 02_EnumerateDevices
|
||||
\include RAII_Samples/02_EnumerateDevices/02_EnumerateDevices.cpp
|
||||
|
||||
\page RAII_Samples_03_InitDevice 03_InitDevice
|
||||
\include RAII_Samples/03_InitDevice/03_InitDevice.cpp
|
||||
|
||||
\page RAII_Samples_04_InitCommandBuffer 04_InitCommandBuffer
|
||||
\include RAII_Samples/04_InitCommandBuffer/04_InitCommandBuffer.cpp
|
||||
|
||||
\page RAII_Samples_05_InitSwapchain 05_InitSwapchain
|
||||
\include RAII_Samples/05_InitSwapchain/05_InitSwapchain.cpp
|
||||
|
||||
\page RAII_Samples_06_InitDepthBuffer 06_InitDepthBuffer
|
||||
\include RAII_Samples/06_InitDepthBuffer/06_InitDepthBuffer.cpp
|
||||
|
||||
\page RAII_Samples_07_InitUniformBuffer 07_InitUniformBuffer
|
||||
\include RAII_Samples/07_InitUniformBuffer/07_InitUniformBuffer.cpp
|
||||
|
||||
\page RAII_Samples_08_InitPipelineLayout 08_InitPipelineLayout
|
||||
\include RAII_Samples/08_InitPipelineLayout/08_InitPipelineLayout.cpp
|
||||
|
||||
\page RAII_Samples_09_InitDescriptorSet 09_InitDescriptorSet
|
||||
\include RAII_Samples/09_InitDescriptorSet/09_InitDescriptorSet.cpp
|
||||
|
||||
\page RAII_Samples_10_InitRenderPass 10_InitRenderPass
|
||||
\include RAII_Samples/10_InitRenderPass/10_InitRenderPass.cpp
|
||||
|
||||
\page RAII_Samples_11_InitShaders 11_InitShaders
|
||||
\include RAII_Samples/11_InitShaders/11_InitShaders.cpp
|
||||
|
||||
\page RAII_Samples_12_InitFrameBuffers 12_InitFrameBuffers
|
||||
\include RAII_Samples/12_InitFrameBuffers/12_InitFrameBuffers.cpp
|
||||
|
||||
\page RAII_Samples_13_InitVertexBuffer 13_InitVertexBuffer
|
||||
\include RAII_Samples/13_InitVertexBuffer/13_InitVertexBuffer.cpp
|
||||
|
||||
\page RAII_Samples_14_InitPipeline 14_InitPipeline
|
||||
\include RAII_Samples/14_InitPipeline/14_InitPipeline.cpp
|
||||
|
||||
\page RAII_Samples_15_DrawCube 15_DrawCube
|
||||
\include RAII_Samples/15_DrawCube/15_DrawCube.cpp
|
||||
|
||||
\page RAII_Samples_16_Vulkan_1_1 16_Vulkan_1_1
|
||||
\include RAII_Samples/16_Vulkan_1_1/16_Vulkan_1_1.cpp
|
||||
|
||||
\page RAII_Samples_CopyBlitImage CopyBlitImage
|
||||
\include RAII_Samples/CopyBlitImage/CopyBlitImage.cpp
|
||||
|
||||
\page RAII_Samples_CreateDebugUtilsMessenger CreateDebugUtilsMessenger
|
||||
\include RAII_Samples/CreateDebugUtilsMessenger/CreateDebugUtilsMessenger.cpp
|
||||
|
||||
\page RAII_Samples_DebugUtilsObjectName DebugUtilsObjectName
|
||||
\include RAII_Samples/DebugUtilsObjectName/DebugUtilsObjectName.cpp
|
||||
|
||||
\page RAII_Samples_DrawTexturedCube DrawTexturedCube
|
||||
\include RAII_Samples/DrawTexturedCube/DrawTexturedCube.cpp
|
||||
|
||||
\page RAII_Samples_DynamicUniform DynamicUniform
|
||||
\include RAII_Samples/DynamicUniform/DynamicUniform.cpp
|
||||
|
||||
\page RAII_Samples_EnableValidationWithCallback EnableValidationWithCallback
|
||||
\include RAII_Samples/EnableValidationWithCallback/EnableValidationWithCallback.cpp
|
||||
|
||||
\page RAII_Samples_EnumerateDevicesAdvanced EnumerateDevicesAdvanced
|
||||
\include RAII_Samples/EnumerateDevicesAdvanced/EnumerateDevicesAdvanced.cpp
|
||||
|
||||
\page RAII_Samples_Events Events
|
||||
\include RAII_Samples/Events/Events.cpp
|
||||
|
||||
\page RAII_Samples_ImmutableSampler ImmutableSampler
|
||||
\include RAII_Samples/ImmutableSampler/ImmutableSampler.cpp
|
||||
|
||||
\page RAII_Samples_InitTexture InitTexture
|
||||
\include RAII_Samples/InitTexture/InitTexture.cpp
|
||||
|
||||
\page RAII_Samples_InputAttachment InputAttachment
|
||||
\include RAII_Samples/InputAttachment/InputAttachment.cpp
|
||||
|
||||
\page RAII_Samples_InstanceExtensionProperties InstanceExtensionProperties
|
||||
\include RAII_Samples/InstanceExtensionProperties/InstanceExtensionProperties.cpp
|
||||
|
||||
\page RAII_Samples_InstanceLayerExtensionProperties InstanceLayerExtensionProperties
|
||||
\include RAII_Samples/InstanceLayerExtensionProperties/InstanceLayerExtensionProperties.cpp
|
||||
|
||||
\page RAII_Samples_InstanceLayerProperties InstanceLayerProperties
|
||||
\include RAII_Samples/InstanceLayerProperties/InstanceLayerProperties.cpp
|
||||
|
||||
\page RAII_Samples_InstanceVersion InstanceVersion
|
||||
\include RAII_Samples/InstanceVersion/InstanceVersion.cpp
|
||||
|
||||
\page RAII_Samples_MultipleSets MultipleSets
|
||||
\include RAII_Samples/MultipleSets/MultipleSets.cpp
|
||||
|
||||
\page RAII_Samples_OcclusionQuery OcclusionQuery
|
||||
\include RAII_Samples/OcclusionQuery/OcclusionQuery.cpp
|
||||
|
||||
\page RAII_Samples_PhysicalDeviceExtensions PhysicalDeviceExtensions
|
||||
\include RAII_Samples/PhysicalDeviceExtensions/PhysicalDeviceExtensions.cpp
|
||||
|
||||
\page RAII_Samples_PhysicalDeviceFeatures PhysicalDeviceFeatures
|
||||
\include RAII_Samples/PhysicalDeviceFeatures/PhysicalDeviceFeatures.cpp
|
||||
|
||||
\page RAII_Samples_PhysicalDeviceGroups PhysicalDeviceGroups
|
||||
\include RAII_Samples/PhysicalDeviceGroups/PhysicalDeviceGroups.cpp
|
||||
|
||||
\page RAII_Samples_PhysicalDeviceMemoryProperties PhysicalDeviceMemoryProperties
|
||||
\include RAII_Samples/PhysicalDeviceMemoryProperties/PhysicalDeviceMemoryProperties.cpp
|
||||
|
||||
\page RAII_Samples_PhysicalDeviceProperties PhysicalDeviceProperties
|
||||
\include RAII_Samples/PhysicalDeviceProperties/PhysicalDeviceProperties.cpp
|
||||
|
||||
\page RAII_Samples_PhysicalDeviceQueueFamilyProperties PhysicalDeviceQueueFamilyProperties
|
||||
\include RAII_Samples/PhysicalDeviceQueueFamilyProperties/PhysicalDeviceQueueFamilyProperties.cpp
|
||||
|
||||
\page RAII_Samples_PipelineCache PipelineCache
|
||||
\include RAII_Samples/PipelineCache/PipelineCache.cpp
|
||||
|
||||
\page RAII_Samples_PipelineDerivative PipelineDerivative
|
||||
\include RAII_Samples/PipelineDerivative/PipelineDerivative.cpp
|
||||
|
||||
\page RAII_Samples_PushConstants PushConstants
|
||||
\include RAII_Samples/PushConstants/PushConstants.cpp
|
||||
|
||||
\page RAII_Samples_PushDescriptors PushDescriptors
|
||||
\include RAII_Samples/PushDescriptors/PushDescriptors.cpp
|
||||
|
||||
\page RAII_Samples_RayTracing RayTracing
|
||||
\include RAII_Samples/RayTracing/RayTracing.cpp
|
||||
|
||||
\page RAII_Samples_SecondaryCommandBuffer SecondaryCommandBuffer
|
||||
\include RAII_Samples/SecondaryCommandBuffer/SecondaryCommandBuffer.cpp
|
||||
|
||||
\page RAII_Samples_SeparateImageSampler SeparateImageSampler
|
||||
\include RAII_Samples/SeparateImageSampler/SeparateImageSampler.cpp
|
||||
|
||||
\page RAII_Samples_SurfaceCapabilities SurfaceCapabilities
|
||||
\include RAII_Samples/SurfaceCapabilities/SurfaceCapabilities.cpp
|
||||
|
||||
\page RAII_Samples_SurfaceFormats SurfaceFormats
|
||||
\include RAII_Samples/SurfaceFormats/SurfaceFormats.cpp
|
||||
|
||||
\page RAII_Samples_Template Template
|
||||
\include RAII_Samples/Template/Template.cpp
|
||||
|
||||
\page RAII_Samples_TexelBuffer TexelBuffer
|
||||
\include RAII_Samples/TexelBuffer/TexelBuffer.cpp
|
||||
*/
|
266
docs/Samples.dox
Normal file
266
docs/Samples.dox
Normal file
@ -0,0 +1,266 @@
|
||||
/**
|
||||
\cond
|
||||
File generate using `python3 docs/generate_samples_dox.py`
|
||||
\endcond
|
||||
\page Samples Samples
|
||||
\subpage Samples_01_InitInstance
|
||||
|
||||
\subpage Samples_02_EnumerateDevices
|
||||
|
||||
\subpage Samples_03_InitDevice
|
||||
|
||||
\subpage Samples_04_InitCommandBuffer
|
||||
|
||||
\subpage Samples_05_InitSwapchain
|
||||
|
||||
\subpage Samples_06_InitDepthBuffer
|
||||
|
||||
\subpage Samples_07_InitUniformBuffer
|
||||
|
||||
\subpage Samples_08_InitPipelineLayout
|
||||
|
||||
\subpage Samples_09_InitDescriptorSet
|
||||
|
||||
\subpage Samples_10_InitRenderPass
|
||||
|
||||
\subpage Samples_11_InitShaders
|
||||
|
||||
\subpage Samples_12_InitFrameBuffers
|
||||
|
||||
\subpage Samples_13_InitVertexBuffer
|
||||
|
||||
\subpage Samples_14_InitPipeline
|
||||
|
||||
\subpage Samples_15_DrawCube
|
||||
|
||||
\subpage Samples_16_Vulkan_1_1
|
||||
|
||||
\subpage Samples_CopyBlitImage
|
||||
|
||||
\subpage Samples_CreateDebugUtilsMessenger
|
||||
|
||||
\subpage Samples_DebugUtilsObjectName
|
||||
|
||||
\subpage Samples_DrawTexturedCube
|
||||
|
||||
\subpage Samples_DynamicUniform
|
||||
|
||||
\subpage Samples_EnableValidationWithCallback
|
||||
|
||||
\subpage Samples_EnumerateDevicesAdvanced
|
||||
|
||||
\subpage Samples_Events
|
||||
|
||||
\subpage Samples_ImmutableSampler
|
||||
|
||||
\subpage Samples_InitTexture
|
||||
|
||||
\subpage Samples_InputAttachment
|
||||
|
||||
\subpage Samples_InstanceExtensionProperties
|
||||
|
||||
\subpage Samples_InstanceLayerExtensionProperties
|
||||
|
||||
\subpage Samples_InstanceLayerProperties
|
||||
|
||||
\subpage Samples_InstanceVersion
|
||||
|
||||
\subpage Samples_MultipleSets
|
||||
|
||||
\subpage Samples_OcclusionQuery
|
||||
|
||||
\subpage Samples_PhysicalDeviceExtensions
|
||||
|
||||
\subpage Samples_PhysicalDeviceFeatures
|
||||
|
||||
\subpage Samples_PhysicalDeviceGroups
|
||||
|
||||
\subpage Samples_PhysicalDeviceMemoryProperties
|
||||
|
||||
\subpage Samples_PhysicalDeviceProperties
|
||||
|
||||
\subpage Samples_PhysicalDeviceQueueFamilyProperties
|
||||
|
||||
\subpage Samples_PipelineCache
|
||||
|
||||
\subpage Samples_PipelineDerivative
|
||||
|
||||
\subpage Samples_PushConstants
|
||||
|
||||
\subpage Samples_PushDescriptors
|
||||
|
||||
\subpage Samples_RayTracing
|
||||
|
||||
\subpage Samples_SecondaryCommandBuffer
|
||||
|
||||
\subpage Samples_SeparateImageSampler
|
||||
|
||||
\subpage Samples_SharedHandles
|
||||
|
||||
\subpage Samples_SurfaceCapabilities
|
||||
|
||||
\subpage Samples_SurfaceFormats
|
||||
|
||||
\subpage Samples_Template
|
||||
|
||||
\subpage Samples_TexelBuffer
|
||||
|
||||
\subpage Samples_utils
|
||||
|
||||
|
||||
\page Samples_01_InitInstance 01_InitInstance
|
||||
\include samples/01_InitInstance/01_InitInstance.cpp
|
||||
|
||||
\page Samples_02_EnumerateDevices 02_EnumerateDevices
|
||||
\include samples/02_EnumerateDevices/02_EnumerateDevices.cpp
|
||||
|
||||
\page Samples_03_InitDevice 03_InitDevice
|
||||
\include samples/03_InitDevice/03_InitDevice.cpp
|
||||
|
||||
\page Samples_04_InitCommandBuffer 04_InitCommandBuffer
|
||||
\include samples/04_InitCommandBuffer/04_InitCommandBuffer.cpp
|
||||
|
||||
\page Samples_05_InitSwapchain 05_InitSwapchain
|
||||
\include samples/05_InitSwapchain/05_InitSwapchain.cpp
|
||||
|
||||
\page Samples_06_InitDepthBuffer 06_InitDepthBuffer
|
||||
\include samples/06_InitDepthBuffer/06_InitDepthBuffer.cpp
|
||||
|
||||
\page Samples_07_InitUniformBuffer 07_InitUniformBuffer
|
||||
\include samples/07_InitUniformBuffer/07_InitUniformBuffer.cpp
|
||||
|
||||
\page Samples_08_InitPipelineLayout 08_InitPipelineLayout
|
||||
\include samples/08_InitPipelineLayout/08_InitPipelineLayout.cpp
|
||||
|
||||
\page Samples_09_InitDescriptorSet 09_InitDescriptorSet
|
||||
\include samples/09_InitDescriptorSet/09_InitDescriptorSet.cpp
|
||||
|
||||
\page Samples_10_InitRenderPass 10_InitRenderPass
|
||||
\include samples/10_InitRenderPass/10_InitRenderPass.cpp
|
||||
|
||||
\page Samples_11_InitShaders 11_InitShaders
|
||||
\include samples/11_InitShaders/11_InitShaders.cpp
|
||||
|
||||
\page Samples_12_InitFrameBuffers 12_InitFrameBuffers
|
||||
\include samples/12_InitFrameBuffers/12_InitFrameBuffers.cpp
|
||||
|
||||
\page Samples_13_InitVertexBuffer 13_InitVertexBuffer
|
||||
\include samples/13_InitVertexBuffer/13_InitVertexBuffer.cpp
|
||||
|
||||
\page Samples_14_InitPipeline 14_InitPipeline
|
||||
\include samples/14_InitPipeline/14_InitPipeline.cpp
|
||||
|
||||
\page Samples_15_DrawCube 15_DrawCube
|
||||
\include samples/15_DrawCube/15_DrawCube.cpp
|
||||
|
||||
\page Samples_16_Vulkan_1_1 16_Vulkan_1_1
|
||||
\include samples/16_Vulkan_1_1/16_Vulkan_1_1.cpp
|
||||
|
||||
\page Samples_CopyBlitImage CopyBlitImage
|
||||
\include samples/CopyBlitImage/CopyBlitImage.cpp
|
||||
|
||||
\page Samples_CreateDebugUtilsMessenger CreateDebugUtilsMessenger
|
||||
\include samples/CreateDebugUtilsMessenger/CreateDebugUtilsMessenger.cpp
|
||||
|
||||
\page Samples_DebugUtilsObjectName DebugUtilsObjectName
|
||||
\include samples/DebugUtilsObjectName/DebugUtilsObjectName.cpp
|
||||
|
||||
\page Samples_DrawTexturedCube DrawTexturedCube
|
||||
\include samples/DrawTexturedCube/DrawTexturedCube.cpp
|
||||
|
||||
\page Samples_DynamicUniform DynamicUniform
|
||||
\include samples/DynamicUniform/DynamicUniform.cpp
|
||||
|
||||
\page Samples_EnableValidationWithCallback EnableValidationWithCallback
|
||||
\include samples/EnableValidationWithCallback/EnableValidationWithCallback.cpp
|
||||
|
||||
\page Samples_EnumerateDevicesAdvanced EnumerateDevicesAdvanced
|
||||
\include samples/EnumerateDevicesAdvanced/EnumerateDevicesAdvanced.cpp
|
||||
|
||||
\page Samples_Events Events
|
||||
\include samples/Events/Events.cpp
|
||||
|
||||
\page Samples_ImmutableSampler ImmutableSampler
|
||||
\include samples/ImmutableSampler/ImmutableSampler.cpp
|
||||
|
||||
\page Samples_InitTexture InitTexture
|
||||
\include samples/InitTexture/InitTexture.cpp
|
||||
|
||||
\page Samples_InputAttachment InputAttachment
|
||||
\include samples/InputAttachment/InputAttachment.cpp
|
||||
|
||||
\page Samples_InstanceExtensionProperties InstanceExtensionProperties
|
||||
\include samples/InstanceExtensionProperties/InstanceExtensionProperties.cpp
|
||||
|
||||
\page Samples_InstanceLayerExtensionProperties InstanceLayerExtensionProperties
|
||||
\include samples/InstanceLayerExtensionProperties/InstanceLayerExtensionProperties.cpp
|
||||
|
||||
\page Samples_InstanceLayerProperties InstanceLayerProperties
|
||||
\include samples/InstanceLayerProperties/InstanceLayerProperties.cpp
|
||||
|
||||
\page Samples_InstanceVersion InstanceVersion
|
||||
\include samples/InstanceVersion/InstanceVersion.cpp
|
||||
|
||||
\page Samples_MultipleSets MultipleSets
|
||||
\include samples/MultipleSets/MultipleSets.cpp
|
||||
|
||||
\page Samples_OcclusionQuery OcclusionQuery
|
||||
\include samples/OcclusionQuery/OcclusionQuery.cpp
|
||||
|
||||
\page Samples_PhysicalDeviceExtensions PhysicalDeviceExtensions
|
||||
\include samples/PhysicalDeviceExtensions/PhysicalDeviceExtensions.cpp
|
||||
|
||||
\page Samples_PhysicalDeviceFeatures PhysicalDeviceFeatures
|
||||
\include samples/PhysicalDeviceFeatures/PhysicalDeviceFeatures.cpp
|
||||
|
||||
\page Samples_PhysicalDeviceGroups PhysicalDeviceGroups
|
||||
\include samples/PhysicalDeviceGroups/PhysicalDeviceGroups.cpp
|
||||
|
||||
\page Samples_PhysicalDeviceMemoryProperties PhysicalDeviceMemoryProperties
|
||||
\include samples/PhysicalDeviceMemoryProperties/PhysicalDeviceMemoryProperties.cpp
|
||||
|
||||
\page Samples_PhysicalDeviceProperties PhysicalDeviceProperties
|
||||
\include samples/PhysicalDeviceProperties/PhysicalDeviceProperties.cpp
|
||||
|
||||
\page Samples_PhysicalDeviceQueueFamilyProperties PhysicalDeviceQueueFamilyProperties
|
||||
\include samples/PhysicalDeviceQueueFamilyProperties/PhysicalDeviceQueueFamilyProperties.cpp
|
||||
|
||||
\page Samples_PipelineCache PipelineCache
|
||||
\include samples/PipelineCache/PipelineCache.cpp
|
||||
|
||||
\page Samples_PipelineDerivative PipelineDerivative
|
||||
\include samples/PipelineDerivative/PipelineDerivative.cpp
|
||||
|
||||
\page Samples_PushConstants PushConstants
|
||||
\include samples/PushConstants/PushConstants.cpp
|
||||
|
||||
\page Samples_PushDescriptors PushDescriptors
|
||||
\include samples/PushDescriptors/PushDescriptors.cpp
|
||||
|
||||
\page Samples_RayTracing RayTracing
|
||||
\include samples/RayTracing/RayTracing.cpp
|
||||
|
||||
\page Samples_SecondaryCommandBuffer SecondaryCommandBuffer
|
||||
\include samples/SecondaryCommandBuffer/SecondaryCommandBuffer.cpp
|
||||
|
||||
\page Samples_SeparateImageSampler SeparateImageSampler
|
||||
\include samples/SeparateImageSampler/SeparateImageSampler.cpp
|
||||
|
||||
\page Samples_SharedHandles SharedHandles
|
||||
\include samples/SharedHandles/SharedHandles.cpp
|
||||
|
||||
\page Samples_SurfaceCapabilities SurfaceCapabilities
|
||||
\include samples/SurfaceCapabilities/SurfaceCapabilities.cpp
|
||||
|
||||
\page Samples_SurfaceFormats SurfaceFormats
|
||||
\include samples/SurfaceFormats/SurfaceFormats.cpp
|
||||
|
||||
\page Samples_Template Template
|
||||
\include samples/Template/Template.cpp
|
||||
|
||||
\page Samples_TexelBuffer TexelBuffer
|
||||
\include samples/TexelBuffer/TexelBuffer.cpp
|
||||
|
||||
\page Samples_utils utils
|
||||
\include samples/utils/utils.cpp
|
||||
*/
|
48
docs/generate_samples_dox.py
Normal file
48
docs/generate_samples_dox.py
Normal file
@ -0,0 +1,48 @@
|
||||
"""
|
||||
Generate Samples.dox RAII_Samples.dox
|
||||
"""
|
||||
|
||||
import argparse
|
||||
from glob import glob
|
||||
from os.path import isfile, join, basename
|
||||
import sys
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument('-s', '--sample-folder', help="Sample folder", default="samples")
|
||||
parser.add_argument('-o', '--output-file', help="Output file", default="docs/Samples.dox")
|
||||
args = parser.parse_args()
|
||||
|
||||
with open(args.output_file, 'w') as f:
|
||||
f.write(fr"""/**
|
||||
\cond
|
||||
File generate using `python3 {' '.join(sys.argv)}`
|
||||
\endcond
|
||||
\page {basename(args.output_file).replace('.dox', '')} {basename(args.output_file).replace('.dox', '').replace('_', ' ')}
|
||||
""") # noqa
|
||||
pages = []
|
||||
for sample in sorted(glob(join(args.sample_folder, '*'))):
|
||||
file = join(sample, basename(sample) + '.cpp')
|
||||
if isfile(file):
|
||||
pages.append({
|
||||
'file': file,
|
||||
'page': basename(args.output_file).replace('.dox', '') + '_' + basename(sample),
|
||||
'title': basename(sample),
|
||||
})
|
||||
for page in pages:
|
||||
f.write(f"""\\subpage {page['page']}\n\n""")
|
||||
|
||||
for page in pages:
|
||||
f.write(rf"""
|
||||
\page {page['page']} {page['title']}
|
||||
\include {page['file']}
|
||||
""")
|
||||
f.write(r"*/")
|
||||
with open(args.output_file) as f:
|
||||
print(f.read())
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
10
docs/mainpage.dox
Normal file
10
docs/mainpage.dox
Normal file
@ -0,0 +1,10 @@
|
||||
/**
|
||||
|
||||
\mainpage Vulkan-Hpp
|
||||
|
||||
- \ref README.md \n
|
||||
- \ref vk_raii_ProgrammingGuide.md \n
|
||||
- \ref Samples \n
|
||||
- \ref RAII_Samples \n
|
||||
|
||||
*/
|
1
doxygen-awesome-css
Submodule
1
doxygen-awesome-css
Submodule
@ -0,0 +1 @@
|
||||
Subproject commit df88fe4fdd97714fadfd3ef17de0b4401f804052
|
Loading…
Reference in New Issue
Block a user