/ scripts / Retired / refDesc.py
refDesc.py
  1  #!/usr/bin/python3
  2  #
  3  # Copyright (c) 2016-2019 The Khronos Group Inc.
  4  #
  5  # Licensed under the Apache License, Version 2.0 (the "License");
  6  # you may not use this file except in compliance with the License.
  7  # You may obtain a copy of the License at
  8  #
  9  #     http://www.apache.org/licenses/LICENSE-2.0
 10  #
 11  # Unless required by applicable law or agreed to in writing, software
 12  # distributed under the License is distributed on an "AS IS" BASIS,
 13  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  # See the License for the specific language governing permissions and
 15  # limitations under the License.
 16  
 17  refDesc = {}
 18  
 19  # These are extracted from the original handwritten ref pages
 20  # This is a one-time measure to inject // refBegin markup into the spec.
 21  
 22  refDesc['vkAcquireNextImageKHR'] = 'Retrieve the index of the next available presentable image'
 23  refDesc['vkAllocateCommandBuffers'] = 'Allocate command buffers from an existing command pool'
 24  refDesc['vkAllocateDescriptorSets'] = 'Allocate one or more descriptor sets'
 25  refDesc['vkAllocateMemory'] = 'Allocate GPU memory'
 26  refDesc['VkAllocationCallbacks'] = 'Structure containing callback function pointers for memory allocation'
 27  refDesc['vkBeginCommandBuffer'] = 'Start recording a command buffer'
 28  refDesc['vkBindBufferMemory'] = 'Bind device memory to a buffer object'
 29  refDesc['vkBindImageMemory'] = 'Bind device memory to an image object'
 30  refDesc['VkBufferCreateFlags'] = 'Buffer object creation flags'
 31  refDesc['VkBufferCreateInfo'] = 'Structure specifying the parameters of a newly created buffer object'
 32  refDesc['VkBufferMemoryBarrier'] = 'Structure specifying the parameters of a buffer memory barrier'
 33  refDesc['VkBufferUsageFlags'] = 'Buffer object usage flags'
 34  refDesc['vkCmdBeginQuery'] = 'Begin a query'
 35  refDesc['vkCmdBeginRenderPass'] = 'Begin a new render pass'
 36  refDesc['vkCmdBindDescriptorSets'] = 'Binds descriptor sets to a command buffer'
 37  refDesc['vkCmdBindIndexBuffer'] = 'Bind an index buffer to a command buffer'
 38  refDesc['vkCmdBindPipeline'] = 'Bind a pipeline object to a command buffer'
 39  refDesc['vkCmdBindVertexBuffers'] = 'Bind vertex buffers to a command buffer'
 40  refDesc['vkCmdBlitImage'] = 'Copy regions of an image, potentially performing format conversion,'
 41  refDesc['vkCmdClearAttachments'] = 'Clear regions within currently bound framebuffer attachments'
 42  refDesc['vkCmdClearColorImage'] = 'Clear regions of a color image'
 43  refDesc['vkCmdClearDepthStencilImage'] = 'Fill regions of a combined depth-stencil image'
 44  refDesc['vkCmdCopyBufferToImage'] = 'Copy data from a buffer into an image'
 45  refDesc['vkCmdCopyBuffer'] = 'Copy data between buffer regions'
 46  refDesc['vkCmdCopyImageToBuffer'] = 'Copy image data into a buffer'
 47  refDesc['vkCmdCopyImage'] = 'Copy data between images'
 48  refDesc['vkCmdCopyQueryPoolResults'] = 'Copy the results of queries in a query pool to a buffer object'
 49  refDesc['vkCmdDispatchIndirect'] = 'Dispatch compute work items using indirect parameters'
 50  refDesc['vkCmdDispatch'] = 'Dispatch compute work items'
 51  refDesc['vkCmdDrawIndexedIndirect'] = 'Perform an indexed indirect draw'
 52  refDesc['vkCmdDrawIndexed'] = 'Issue an indexed draw into a command buffer'
 53  refDesc['vkCmdDrawIndirect'] = 'Issue an indirect draw into a command buffer'
 54  refDesc['vkCmdDraw'] = 'Draw primitives'
 55  refDesc['vkCmdEndQuery'] = 'Ends a query'
 56  refDesc['vkCmdEndRenderPass'] = 'End the current render pass'
 57  refDesc['vkCmdExecuteCommands'] = 'Execute a secondary command buffer from a primary command buffer'
 58  refDesc['vkCmdFillBuffer'] = 'Fill a region of a buffer with a fixed value'
 59  refDesc['vkCmdNextSubpass'] = 'Transition to the next subpass of a render pass'
 60  refDesc['vkCmdPipelineBarrier'] = 'Insert a set of execution and memory barriers'
 61  refDesc['vkCmdPushConstants'] = 'Update the values of push constants'
 62  refDesc['vkCmdResetEvent'] = 'Reset an event object to non-signaled state'
 63  refDesc['vkCmdResetQueryPool'] = 'Reset queries in a query pool'
 64  refDesc['vkCmdResolveImage'] = 'Resolve regions of an image'
 65  refDesc['vkCmdSetBlendConstants'] = 'Set the values of blend constants'
 66  refDesc['vkCmdSetDepthBias'] = 'Set the depth bias dynamic state'
 67  refDesc['vkCmdSetDepthBounds'] = 'Set the depth bounds test values for a command buffer'
 68  refDesc['vkCmdSetEvent'] = 'Set an event object to signaled state'
 69  refDesc['vkCmdSetLineWidth'] = 'Set the dynamic line width state'
 70  refDesc['vkCmdSetScissor'] = 'Set the dynamic scissor rectangles on a command buffer'
 71  refDesc['vkCmdSetStencilCompareMask'] = 'Set the stencil compare mask dynamic state'
 72  refDesc['vkCmdSetStencilReference'] = 'Set the stencil reference dynamic state'
 73  refDesc['vkCmdSetStencilWriteMask'] = 'Set the stencil write mask dynamic state'
 74  refDesc['vkCmdSetViewport'] = 'Set the viewport on a command buffer'
 75  refDesc['vkCmdUpdateBuffer'] = 'Update a buffer\'s contents from host memory'
 76  refDesc['vkCmdWaitEvents'] = 'Wait for one or more events and insert a set of memory'
 77  refDesc['vkCmdWriteTimestamp'] = 'Write a device timestamp into a query object'
 78  refDesc['VkCommandBufferAllocateInfo'] = 'Structure specifying the allocation parameters for command buffer object'
 79  refDesc['vkCreateAndroidSurfaceKHR'] = 'Create a slink:VkSurfaceKHR object for an Android native window'
 80  refDesc['vkCreateBuffer'] = 'Create a new buffer object'
 81  refDesc['vkCreateBufferView'] = 'Create a new buffer view object'
 82  refDesc['vkCreateCommandPool'] = 'Create a new command pool object'
 83  refDesc['vkCreateComputePipelines'] = 'Creates a new compute pipeline object'
 84  refDesc['vkCreateDescriptorPool'] = 'Creates a descriptor pool object'
 85  refDesc['vkCreateDescriptorSetLayout'] = 'Create a new descriptor set layout'
 86  refDesc['vkCreateDevice'] = 'Create a new device instance'
 87  refDesc['vkCreateDisplayModeKHR'] = 'Create a display mode'
 88  refDesc['vkCreateDisplayPlaneSurfaceKHR'] = 'Create a slink:VkSurfaceKHR structure representing a display plane and mode'
 89  refDesc['vkCreateEvent'] = 'Create a new event object'
 90  refDesc['vkCreateFence'] = 'Create a new fence object'
 91  refDesc['vkCreateFramebuffer'] = 'Create a new framebuffer object'
 92  refDesc['vkCreateGraphicsPipelines'] = 'Create graphics pipelines'
 93  refDesc['vkCreateImage'] = 'Create a new image object'
 94  refDesc['vkCreateImageView'] = 'Create an image view from an existing image'
 95  refDesc['vkCreateInstance'] = 'Create a new Vulkan instance'
 96  refDesc['vkCreateMirSurfaceKHR'] = 'Create a slink:VkSurfaceKHR object for a Mir window'
 97  refDesc['vkCreatePipelineCache'] = 'Creates a new pipeline cache'
 98  refDesc['vkCreatePipelineLayout'] = 'Creates a new pipeline layout object'
 99  refDesc['vkCreateQueryPool'] = 'Create a new query pool object'
100  refDesc['vkCreateRenderPass'] = 'Create a new render pass object'
101  refDesc['vkCreateSampler'] = 'Create a new sampler object'
102  refDesc['vkCreateSemaphore'] = 'Create a new queue semaphore object'
103  refDesc['vkCreateShaderModule'] = 'Creates a new shader module object'
104  refDesc['vkCreateSharedSwapchainsKHR'] = 'Create multiple swapchains that share presentable images'
105  refDesc['vkCreateSwapchainKHR'] = 'Create a swapchain'
106  refDesc['vkCreateWaylandSurfaceKHR'] = 'Create a slink:VkSurfaceKHR object for a Wayland window'
107  refDesc['vkCreateXcbSurfaceKHR'] = 'Create a slink:VkSurfaceKHR object for a X11 window, using the XCB client-side library'
108  refDesc['vkCreateXlibSurfaceKHR'] = 'Create a slink:VkSurfaceKHR object for an X11 window, using the Xlib client-side library'
109  refDesc['VkDescriptorSetAllocateInfo'] = 'Structure specifying the allocation parameters for descriptor sets'
110  refDesc['VkDescriptorType'] = 'Specifies the type of a descriptor in a descriptor set'
111  refDesc['vkDestroyBuffer'] = 'Destroy a buffer object'
112  refDesc['vkDestroyBufferView'] = 'Destroy a buffer view object'
113  refDesc['vkDestroyCommandPool'] = 'Destroy a command pool object'
114  refDesc['vkDestroyDescriptorPool'] = 'Destroy a descriptor pool object'
115  refDesc['vkDestroyDescriptorSetLayout'] = 'Destroy a descriptor set layout object'
116  refDesc['vkDestroyDevice'] = 'Destroy a logical device'
117  refDesc['vkDestroyEvent'] = 'Destroy an event object'
118  refDesc['vkDestroyFence'] = 'Destroy a fence object'
119  refDesc['vkDestroyFramebuffer'] = 'Destroy a framebuffer object'
120  refDesc['vkDestroyImage'] = 'Destroy an image object'
121  refDesc['vkDestroyImageView'] = 'Destroy an image view object'
122  refDesc['vkDestroyInstance'] = 'Destroy an instance of Vulkan'
123  refDesc['vkDestroyPipelineCache'] = 'Destroy a pipeline cache object'
124  refDesc['vkDestroyPipelineLayout'] = 'Destroy a pipeline layout object'
125  refDesc['vkDestroyPipeline'] = 'Destroy a pipeline object'
126  refDesc['vkDestroyQueryPool'] = 'Destroy a query pool object'
127  refDesc['vkDestroyRenderPass'] = 'Destroy a render pass object'
128  refDesc['vkDestroySampler'] = 'Destroy a sampler object'
129  refDesc['vkDestroySemaphore'] = 'Destroy a semaphore object'
130  refDesc['vkDestroyShaderModule'] = 'Destroy a shader module'
131  refDesc['vkDestroySurfaceKHR'] = 'Destroy a VkSurfaceKHR object'
132  refDesc['vkDestroySwapchainKHR'] = 'Destroy a swapchain object'
133  refDesc['vkDeviceWaitIdle'] = 'Wait for a device to become idle'
134  refDesc['vkEndCommandBuffer'] = 'Finish recording a command buffer'
135  refDesc['vkEnumerateDeviceExtensionProperties'] = 'Returns properties of available physical device extensions'
136  refDesc['vkEnumerateDeviceLayerProperties'] = 'Returns properties of available physical device layers'
137  refDesc['vkEnumerateInstanceExtensionProperties'] = 'Returns up to requested number of global extension properties'
138  refDesc['vkEnumerateInstanceLayerProperties'] = 'Returns up to requested number of global layer properties'
139  refDesc['vkEnumeratePhysicalDevices'] = 'Enumerates the physical devices accessible to a Vulkan instance'
140  refDesc['vkFlushMappedMemoryRanges'] = 'Flush mapped memory ranges'
141  refDesc['VkFormatFeatureFlags'] = 'Capability flags of a particular format'
142  refDesc['vkFreeCommandBuffers'] = 'Free command buffers'
143  refDesc['vkFreeDescriptorSets'] = 'Free one or more descriptor sets'
144  refDesc['vkFreeMemory'] = 'Free GPU memory'
145  refDesc['vkGetBufferMemoryRequirements'] = 'Returns the memory requirements for specified Vulkan object'
146  refDesc['vkGetDeviceMemoryCommitment'] = 'Query the current commitment for a VkDeviceMemory'
147  refDesc['vkGetDeviceProcAddr'] = 'Return a function pointer for a command'
148  refDesc['vkGetDeviceQueue'] = 'Get a queue handle from a device'
149  refDesc['vkGetDisplayModePropertiesKHR'] = 'Query the set of mode properties supported by the display'
150  refDesc['vkGetDisplayPlaneCapabilitiesKHR'] = 'Query capabilities of a mode and plane combination'
151  refDesc['vkGetDisplayPlaneSupportedDisplaysKHR'] = 'Query the list of displays a plane supports'
152  refDesc['vkGetEventStatus'] = 'Retrieve the status of an event object'
153  refDesc['vkGetFenceStatus'] = 'Return the status of a fence'
154  refDesc['vkGetImageMemoryRequirements'] = 'Returns the memory requirements for specified Vulkan object'
155  refDesc['vkGetImageSparseMemoryRequirements'] = 'Query the memory requirements for a sparse image'
156  refDesc['vkGetImageSubresourceLayout'] = 'Retrieve information about an image subresource'
157  refDesc['vkGetInstanceProcAddr'] = 'Return a function pointer for a command'
158  refDesc['vkGetPhysicalDeviceDisplayPlanePropertiesKHR'] = 'Query the plane properties'
159  refDesc['vkGetPhysicalDeviceDisplayPropertiesKHR'] = 'Query information about the available displays'
160  refDesc['vkGetPhysicalDeviceFeatures'] = 'Reports capabilities of a physical device'
161  refDesc['vkGetPhysicalDeviceFormatProperties'] = 'Lists physical device\'s format capabilities'
162  refDesc['vkGetPhysicalDeviceImageFormatProperties'] = 'Lists physical device\'s image format capabilities'
163  refDesc['vkGetPhysicalDeviceMemoryProperties'] = 'Reports memory information for the specified physical device'
164  refDesc['vkGetPhysicalDeviceMirPresentationSupportKHR'] = 'Query physical device for presentation to Mir'
165  refDesc['vkGetPhysicalDeviceProperties'] = 'Returns properties of a physical device'
166  refDesc['vkGetPhysicalDeviceQueueFamilyProperties'] = 'Reports properties of the queues of the specified physical device'
167  refDesc['vkGetPhysicalDeviceSparseImageFormatProperties'] = 'Retrieve properties of an image format applied to sparse images'
168  refDesc['vkGetPhysicalDeviceSurfaceCapabilitiesKHR'] = 'Query surface capabilities'
169  refDesc['vkGetPhysicalDeviceSurfaceFormatsKHR'] = 'Query color formats supported by surface'
170  refDesc['vkGetPhysicalDeviceSurfacePresentModesKHR'] = 'Query supported presentation modes'
171  refDesc['vkGetPhysicalDeviceSurfaceSupportKHR'] = 'Query if presentation is supported'
172  refDesc['vkGetPhysicalDeviceWaylandPresentationSupportKHR'] = 'Query physical device for presentation to Wayland'
173  refDesc['vkGetPhysicalDeviceXcbPresentationSupportKHR'] = 'Query physical device for presentation to X11 server using XCB'
174  refDesc['vkGetPhysicalDeviceXlibPresentationSupportKHR'] = 'Query physical device for presentation to X11 server using Xlib'
175  refDesc['vkGetPipelineCacheData'] = 'Get the data store from a pipeline cache'
176  refDesc['vkGetQueryPoolResults'] = 'Copy results of queries in a query pool to a host memory region'
177  refDesc['vkGetRenderAreaGranularity'] = 'Returns the granularity for optimal render area'
178  refDesc['vkGetSwapchainImagesKHR'] = 'Obtain the array of presentable images associated with a swapchain'
179  refDesc['VkImageCreateFlags'] = 'Image object creation flags'
180  refDesc['VkImageCreateInfo'] = 'Structure specifying the parameters of a newly created image object'
181  refDesc['VkImageLayout'] = 'Layout of image and image subresources'
182  refDesc['VkImageMemoryBarrier'] = 'Structure specifying the parameters of an image memory barrier'
183  refDesc['VkImageType'] = 'Specifies the type of an image object'
184  refDesc['VkImageUsageFlags'] = 'Image object usage flags'
185  refDesc['VkImageViewType'] = 'Image view types'
186  refDesc['vkInvalidateMappedMemoryRanges'] = 'Invalidate ranges of mapped memory objects'
187  refDesc['vkMapMemory'] = 'Map a memory object into application address space'
188  refDesc['VkMemoryAllocateInfo'] = 'Structure containing parameters of a memory allocation'
189  refDesc['VkMemoryPropertyFlags'] = 'Memory pool properties'
190  refDesc['vkMergePipelineCaches'] = 'Combine the data stores of pipeline caches'
191  refDesc['VkPhysicalDeviceFeatures'] = 'Structure describing the fine-grained features that can be supported by an implementation'
192  refDesc['VkPhysicalDeviceLimits'] = 'Structure'
193  refDesc['VkPipelineLayoutCreateInfo'] = 'Structure specifying the parameters of a newly created pipeline layout object'
194  refDesc['VkPipelineStageFlags'] = 'Pipeline stage identifiers'
195  refDesc['VkQueryControlFlags'] = 'Query control flags'
196  refDesc['VkQueryResultFlags'] = 'Query result flags'
197  refDesc['vkQueueBindSparse'] = 'Bind device memory to a sparse resource object'
198  refDesc['VkQueueFamilyProperties'] = 'Structure providing information about a queue family'
199  refDesc['VkQueueFlags'] = 'Queue capability flags'
200  refDesc['vkQueuePresentKHR'] = 'Queue an image for presentation'
201  refDesc['vkQueueSubmit'] = 'Submits a sequence of semaphores or command buffers to a queue'
202  refDesc['vkQueueWaitIdle'] = 'Wait for a queue to become idle'
203  refDesc['vkResetCommandBuffer'] = 'Reset a command buffer'
204  refDesc['vkResetCommandPool'] = 'Reset a command pool'
205  refDesc['vkResetDescriptorPool'] = 'Resets a descriptor pool object'
206  refDesc['vkResetEvent'] = 'Reset an event to non-signaled state'
207  refDesc['vkResetFences'] = 'Resets one or more fence objects'
208  refDesc['vkSetEvent'] = 'Set an event to signaled state'
209  refDesc['VkSharingMode'] = 'Buffer and image sharing modes'
210  refDesc['vkUnmapMemory'] = 'Unmap a previously mapped memory object'
211  refDesc['vkUpdateDescriptorSets'] = 'Update the contents of a descriptor set object'
212  refDesc['vkWaitForFences'] = 'Wait for one or more fences to become signaled'
213  refDesc['VkWriteDescriptorSet'] = 'Structure specifying the parameters of a descriptor set write operation'
214  refDesc['VkAndroidSurfaceCreateInfoKHR'] = 'Structure specifying parameters of a newly created Android surface object'
215  refDesc['VkDebugReportCallbackCreateInfoEXT'] = 'Structure specifying parameters of a newly created debug report object'
216  refDesc['VkDisplayModeCreateInfoKHR'] = 'Structure specifying parameters of a newly created display mode object'
217  refDesc['VkDisplayModeParametersKHR'] = 'Structure describing display parameters associated with a display mode'
218  refDesc['VkDisplayModePropertiesKHR'] = 'Structure describing display mode properties'
219  refDesc['VkDisplayPlaneCapabilitiesKHR'] = 'Structure describing capabilities of a mode and plane combination'
220  refDesc['VkDisplayPlanePropertiesKHR'] = 'Structure describing display plane properties'
221  refDesc['VkDisplayPresentInfoKHR'] = 'Structure describing parameters of a queue presentation to a swapchain'
222  refDesc['VkDisplayPropertiesKHR'] = 'Structure describing an available display device'
223  refDesc['VkDisplaySurfaceCreateInfoKHR'] = 'Structure specifying parameters of a newly created display plane surface object'
224  refDesc['VkMirSurfaceCreateInfoKHR'] = 'Structure specifying parameters of a newly created Mir surface object'
225  refDesc['VkPresentInfoKHR'] = 'Structure describing parameters of a queue presentation'
226  refDesc['VkSurfaceCapabilitiesKHR'] = 'Structure describing capabilities of a surface'
227  refDesc['VkSurfaceFormatKHR'] = 'Structure describing a supported swapchain format-colorspace pair'
228  refDesc['VkSwapchainCreateInfoKHR'] = 'Structure specifying parameters of a newly created swapchain object'
229  refDesc['VkWaylandSurfaceCreateInfoKHR'] = 'Structure specifying parameters of a newly created Wayland surface object'
230  refDesc['VkWin32SurfaceCreateInfoKHR'] = 'Structure specifying parameters of a newly created Win32 surface object'
231  refDesc['VkXcbSurfaceCreateInfoKHR'] = 'Structure specifying parameters of a newly created Xcb surface object'
232  refDesc['VkXlibSurfaceCreateInfoKHR'] = 'Structure specifying parameters of a newly created Xlib surface object'
233  
234  # These are generated based on the structure name
235  
236  refDesc['VkBufferViewCreateInfo'] =                 'Structure specifying parameters of a newly created buffer view'
237  refDesc['VkCommandPoolCreateInfo'] =                'Structure specifying parameters of a newly created command pool'
238  refDesc['VkComputePipelineCreateInfo'] =            'Structure specifying parameters of a newly created compute pipeline'
239  refDesc['VkDescriptorPoolCreateInfo'] =             'Structure specifying parameters of a newly created descriptor pool'
240  refDesc['VkDescriptorSetLayoutCreateInfo'] =        'Structure specifying parameters of a newly created descriptor set layout'
241  refDesc['VkDeviceCreateInfo'] =                     'Structure specifying parameters of a newly created device'
242  refDesc['VkDeviceQueueCreateInfo'] =                'Structure specifying parameters of a newly created device queue'
243  refDesc['VkEventCreateInfo'] =                      'Structure specifying parameters of a newly created event'
244  refDesc['VkExtent2D'] =                             'Structure specifying a two-dimensional extent'
245  refDesc['VkExtent3D'] =                             'Structure specifying a three-dimensional extent'
246  refDesc['VkFenceCreateInfo'] =                      'Structure specifying parameters of a newly created fence'
247  refDesc['VkFramebufferCreateInfo'] =                'Structure specifying parameters of a newly created framebuffer'
248  refDesc['VkGraphicsPipelineCreateInfo'] =           'Structure specifying parameters of a newly created graphics pipeline'
249  refDesc['VkImageViewCreateInfo'] =                  'Structure specifying parameters of a newly created image view'
250  refDesc['VkInstanceCreateInfo'] =                   'Structure specifying parameters of a newly created instance'
251  refDesc['VkOffset2D'] =                             'Structure specifying a two-dimensional offset'
252  refDesc['VkOffset3D'] =                             'Structure specifying a three-dimensional offset'
253  refDesc['VkPipelineCacheCreateInfo'] =              'Structure specifying parameters of a newly created pipeline cache'
254  refDesc['VkPipelineColorBlendStateCreateInfo'] =    'Structure specifying parameters of a newly created pipeline color blend state'
255  refDesc['VkPipelineDepthStencilStateCreateInfo'] =  'Structure specifying parameters of a newly created pipeline depth stencil state'
256  refDesc['VkPipelineDynamicStateCreateInfo'] =       'Structure specifying parameters of a newly created pipeline dynamic state'
257  refDesc['VkPipelineInputAssemblyStateCreateInfo'] = 'Structure specifying parameters of a newly created pipeline input assembly state'
258  refDesc['VkPipelineMultisampleStateCreateInfo'] =   'Structure specifying parameters of a newly created pipeline multisample state'
259  refDesc['VkPipelineRasterizationStateCreateInfo'] = 'Structure specifying parameters of a newly created pipeline rasterization state'
260  refDesc['VkPipelineShaderStageCreateInfo'] =        'Structure specifying parameters of a newly created pipeline shader stage'
261  refDesc['VkPipelineTessellationStateCreateInfo'] =  'Structure specifying parameters of a newly created pipeline tessellation state'
262  refDesc['VkPipelineVertexInputStateCreateInfo'] =   'Structure specifying parameters of a newly created pipeline vertex input state'
263  refDesc['VkPipelineViewportStateCreateInfo'] =      'Structure specifying parameters of a newly created pipeline viewport state'
264  refDesc['VkQueryPoolCreateInfo'] =                  'Structure specifying parameters of a newly created query pool'
265  refDesc['VkRect2D'] =                               'Structure specifying a two-dimensional subregion'
266  refDesc['VkRenderPassCreateInfo'] =                 'Structure specifying parameters of a newly created render pass'
267  refDesc['VkSamplerCreateInfo'] =                    'Structure specifying parameters of a newly created sampler'
268  refDesc['VkSemaphoreCreateInfo'] =                  'Structure specifying parameters of a newly created semaphore'
269  refDesc['VkShaderModuleCreateInfo'] =               'Structure specifying parameters of a newly created shader module'
270  
271  # These are TBD
272  
273  refDesc['VkApplicationInfo'] =                      'Structure specifying application info'
274  refDesc['VkAttachmentDescription'] =                'Structure specifying an attachment description'
275  refDesc['VkAttachmentReference'] =                  'Structure specifying an attachment reference'
276  refDesc['VkBindSparseInfo'] =                       'Structure specifying a sparse binding operation'
277  refDesc['VkBufferCopy'] =                           'Structure specifying a buffer copy operation'
278  refDesc['VkBufferImageCopy'] =                      'Structure specifying a buffer image copy operation'
279  refDesc['VkClearAttachment'] =                      'Structure specifying a clear attachment'
280  refDesc['VkClearColorValue'] =                      'Structure specifying a clear color value'
281  refDesc['VkClearDepthStencilValue'] =               'Structure specifying a clear depth stencil value'
282  refDesc['VkClearRect'] =                            'Structure specifying a clear rectangle'
283  refDesc['VkClearValue'] =                           'Structure specifying a clear value'
284  refDesc['VkCommandBufferBeginInfo'] =               'Structure specifying a command buffer begin operation'
285  refDesc['VkCommandBufferInheritanceInfo'] =         'Structure specifying command buffer inheritance info'
286  refDesc['VkCommandBufferLevel'] =                   'Structure specifying a command buffer level'
287  refDesc['VkComponentMapping'] =                     'Structure specifying a color component mapping'
288  refDesc['VkCopyDescriptorSet'] =                    'Structure specifying a copy descriptor set operation'
289  refDesc['VkDescriptorBufferInfo'] =                 'Structure specifying descriptor buffer info'
290  refDesc['VkDescriptorImageInfo'] =                  'Structure specifying descriptor image info'
291  refDesc['VkDescriptorPoolSize'] =                   'Structure specifying descriptor pool size'
292  refDesc['VkDescriptorSetLayoutBinding'] =           'Structure specifying a descriptor set layout binding'
293  refDesc['VkDispatchIndirectCommand'] =              'Structure specifying a dispatch indirect command'
294  refDesc['VkDrawIndexedIndirectCommand'] =           'Structure specifying a draw indexed indirect command'
295  refDesc['VkDrawIndirectCommand'] =                  'Structure specifying a draw indirect command'
296  refDesc['VkExtensionProperties'] =                  'Structure specifying a extension properties'
297  refDesc['VkFormatProperties'] =                     'Structure specifying image format properties'
298  refDesc['VkImageBlit'] =                            'Structure specifying an image blit operation'
299  refDesc['VkImageCopy'] =                            'Structure specifying an image copy operation'
300  refDesc['VkImageFormatProperties'] =                'Structure specifying a image format properties'
301  refDesc['VkImageResolve'] =                         'Structure specifying an image resolve operation'
302  refDesc['VkImageSubresource'] =                     'Structure specifying a image subresource'
303  refDesc['VkImageSubresourceLayers'] =               'Structure specifying a image subresource layers'
304  refDesc['VkImageSubresourceRange'] =                'Structure specifying a image subresource range'
305  refDesc['VkLayerProperties'] =                      'Structure specifying layer properties'
306  refDesc['VkMappedMemoryRange'] =                    'Structure specifying a mapped memory range'
307  refDesc['VkMemoryBarrier'] =                        'Structure specifying a memory barrier'
308  refDesc['VkMemoryHeap'] =                           'Structure specifying a memory heap'
309  refDesc['VkMemoryRequirements'] =                   'Structure specifying memory requirements'
310  refDesc['VkMemoryType'] =                           'Structure specifying memory type'
311  refDesc['VkPhysicalDeviceMemoryProperties'] =       'Structure specifying physical device memory properties'
312  refDesc['VkPhysicalDeviceProperties'] =             'Structure specifying physical device properties'
313  refDesc['VkPhysicalDeviceSparseProperties'] =       'Structure specifying physical device sparse memory properties'
314  refDesc['VkPipelineColorBlendAttachmentState'] =    'Structure specifying a pipeline color blend attachment state'
315  refDesc['VkPushConstantRange'] =                    'Structure specifying a push constant range'
316  refDesc['VkRenderPassBeginInfo'] =                  'Structure specifying render pass begin info'
317  refDesc['VkSparseBufferMemoryBindInfo'] =           'Structure specifying a sparse buffer memory bind operation'
318  refDesc['VkSparseImageFormatProperties'] =          'Structure specifying sparse image format properties'
319  refDesc['VkSparseImageMemoryBind'] =                'Structure specifying sparse image memory bind'
320  refDesc['VkSparseImageMemoryBindInfo'] =            'Structure specifying sparse image memory bind info'
321  refDesc['VkSparseImageMemoryRequirements'] =        'Structure specifying sparse image memory requirements'
322  refDesc['VkSparseImageOpaqueMemoryBindInfo'] =      'Structure specifying sparse image opaque memory bind info'
323  refDesc['VkSparseMemoryBind'] =                     'Structure specifying a sparse memory bind operation'
324  refDesc['VkSpecializationInfo'] =                   'Structure specifying specialization info'
325  refDesc['VkSpecializationMapEntry'] =               'Structure specifying a specialization map entry'
326  refDesc['VkStencilOpState'] =                       'Structure specifying stencil operation state'
327  refDesc['VkSubmitInfo'] =                           'Structure specifying a queue submit operation'
328  refDesc['VkSubpassDependency'] =                    'Structure specifying a subpass dependency'
329  refDesc['VkSubpassDescription'] =                   'Structure specifying a subpass description'
330  refDesc['VkSubresourceLayout'] =                    'Structure specifying subresource layout'
331  refDesc['VkVertexInputAttributeDescription'] =      'Structure specifying vertex input attribute description'
332  refDesc['VkVertexInputBindingDescription'] =        'Structure specifying vertex input binding description'
333  refDesc['VkViewport'] =                             'Structure specifying a viewport'
334  
335  # These are constructed from spec text
336  
337  refDesc['VkAccessFlagBits'] =                  'Bitmask specifying classes of memory access the will participate in a memory barrier dependency'
338  refDesc['VkAttachmentDescriptionFlagBits'] =   'Bitmask specifying additional properties of an attachment'
339  refDesc['VkBufferCreateFlagBits'] =            'Bitmask specifying additional parameters of a buffer'
340  refDesc['VkBufferUsageFlagBits'] =             'Bitmask specifying allowed usage of a buffer'
341  refDesc['VkColorComponentFlagBits'] =          'Bitmask controlling which components are written to the framebuffer'
342  refDesc['VkCommandBufferResetFlagBits'] =      'Bitmask controlling behavior of a command buffer reset'
343  refDesc['VkCommandBufferUsageFlagBits'] =      'Bitmask specifying usage behavior for command buffer'
344  refDesc['VkCommandPoolCreateFlagBits'] =       'Bitmask specifying usage behavior for a command pool'
345  refDesc['VkCommandPoolResetFlagBits'] =        'Bitmask controlling behavior of a command pool reset'
346  refDesc['VkCullModeFlagBits'] =                'Bitmask controlling triangle culling'
347  refDesc['VkDependencyFlagBits'] =              'Bitmask specifying dependencies between subpasses'
348  refDesc['VkDescriptorPoolCreateFlagBits'] =    'Bitmask specifying certain supported operations on a descriptor pool'
349  refDesc['VkFenceCreateFlagBits'] =             'Bitmask specifying initial state and behavior of a fence'
350  refDesc['VkFormatFeatureFlagBits'] =           'Bitmask specifying features supported by a buffer'
351  refDesc['VkImageAspectFlagBits'] =             'Bitmask specifying which aspects of an image are included in a view'
352  refDesc['VkImageCreateFlagBits'] =             'Bitmask specifying additional parameters of an image'
353  refDesc['VkImageUsageFlagBits'] =              'Bitmask specifying intended usage of an image'
354  refDesc['VkMemoryHeapFlagBits'] =              'Bitmask specifying attribute flags for a heap'
355  refDesc['VkMemoryPropertyFlagBits'] =          'Bitmask specifying properties for a memory type'
356  refDesc['VkPipelineCreateFlagBits'] =          'Bitmask controlling how a pipeline is generated'
357  refDesc['VkPipelineStageFlagBits'] =           'Bitmask specifying pipeline stages'
358  refDesc['VkQueryControlFlagBits'] =            'Bitmask specifying constraints on a query'
359  refDesc['VkQueryPipelineStatisticFlagBits'] =  'Bitmask specifying queried pipeline statistics'
360  refDesc['VkQueryResultFlagBits'] =             'Bitmask specifying how and when query results are returned'
361  refDesc['VkQueueFlagBits'] =                   'Bitmask specifying capabilities of queues in a queue family'
362  refDesc['VkSampleCountFlagBits'] =             'Bitmask specifying sample counts supported for an image used for storage operations'
363  refDesc['VkShaderStageFlagBits'] =             'Bitmask specifying a pipeline stage'
364  refDesc['VkSparseImageFormatFlagBits'] =       'Bitmask specifying additional information about a sparse image resource'
365  refDesc['VkSparseMemoryBindFlagBits'] =        'Bitmask specifying usage of a sparse memory binding operation'
366  refDesc['VkStencilFaceFlagBits'] =             'Bitmask specifying sets of stencil state for which to update the compare mask'