Crate vk_parse

Source
Expand description

This crate parses the Vulkan XML registry into a Rust object.

The entry point into this library is parse_file_as_vkxml, which will return a Registry object. This object contains all the information contained in the Vulkan API registry.

Structs§

CommandDefinition
CommandParam
Parameter for this Vulkan function.
CommentedChildren
Enum
An item of an enumeration type.
Enums
Extension
Feature
FeatureEnable
Format
NameWithType
Platform
A platform refers to a windowing system which Vulkan can use.
PropertyEnable
Registry
Rust structure representing the Vulkan registry.
SpirvExtOrCap
SyncAccess
SyncEquivalent
SyncPipeline
SyncPipelineStage
SyncStage
SyncSupport
Tag
Tags are the little suffixes attached to extension names or items, indicating the author.
Type
TypeCode
TypeMemberDefinition
Unused
An unused range of enum values.
VendorId
Unique identifier for a Vulkan vendor.
VideoCapabilities
VideoCodec
VideoFormat
VideoFormatProperties
VideoProfile
VideoProfileMember
VideoProfiles
VideoRequireCapabilities

Enums§

Command
A command is just a Vulkan function.
Enable
EnumSpec
An enum specifier, which assigns a value to the enum.
EnumsChild
An item which forms an enum.
Error
Errors from which parser can recover. How much information will be missing in the resulting Registry depends on the type of error and situation in which it occurs. For example, unrecognized attribute will simply be skipped without affecting anything around it, while unrecognized element will have all of its contents skipped.
ExtensionChild
A part of an extension declaration.
FatalError
Errors from which parser cannot recover.
FormatChild
InterfaceItem
An interface item is a function or an enum which makes up a Vulkan interface.
RegistryChild
An element of the Vulkan registry.
SyncChild
TypeCodeMarkup
TypeMember
A member of a type definition, i.e. a struct member.
TypeMemberMarkup
TypeSpec
The contents of a type definition.
TypesChild
An item making up a type definition.
VideoCodecChild
VideoFormatChild

Functions§

parse_file
Parses the Vulkan XML file into a Rust object.
parse_stream
Parses the Vulkan XML file from stream into a Rust object.

Type Aliases§

Commands
Extensions
FeatureChild
Formats
Platforms
SpirvCapabilities
SpirvCapability
SpirvExtension
SpirvExtensions
Sync
Tags
Types
VendorIds
VideoCodecs