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§
- Command
Definition - Command
Param - Parameter for this Vulkan function.
- Commented
Children - Enum
- An item of an enumeration type.
- Enums
- Extension
- Feature
- Feature
Enable - Format
- Name
With Type - Platform
- A platform refers to a windowing system which Vulkan can use.
- Property
Enable - Registry
- Rust structure representing the Vulkan registry.
- Spirv
ExtOr Cap - Sync
Access - Sync
Equivalent - Sync
Pipeline - Sync
Pipeline Stage - Sync
Stage - Sync
Support - Tag
- Tags are the little suffixes attached to extension names or items, indicating the author.
- Type
- Type
Code - Type
Member Definition - Unused
- An unused range of enum values.
- Vendor
Id - Unique identifier for a Vulkan vendor.
- Video
Capabilities - Video
Codec - Video
Format - Video
Format Properties - Video
Profile - Video
Profile Member - Video
Profiles - Video
Require Capabilities
Enums§
- Command
- A command is just a Vulkan function.
- Enable
- Enum
Spec - An enum specifier, which assigns a value to the enum.
- Enums
Child - 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.
- Extension
Child - A part of an extension declaration.
- Fatal
Error - Errors from which parser cannot recover.
- Format
Child - Interface
Item - An interface item is a function or an enum which makes up a Vulkan interface.
- Registry
Child - An element of the Vulkan registry.
- Sync
Child - Type
Code Markup - Type
Member - A member of a type definition, i.e. a struct member.
- Type
Member Markup - Type
Spec - The contents of a type definition.
- Types
Child - An item making up a type definition.
- Video
Codec Child - Video
Format Child
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.