Expand description
Glue library between Vulkan and Rust
§Copyright
Some documentation comments are from Vulkan Manual Page.
Copyright (c) 2014-2017 Khronos Group.
§Compile Options
Implements: Enable Vulkan implementations(functions)Multithreaded: Enables to use objects from some threads(experimental)Presentation: Enable rendering features to Window/Display(VK_KHR_surface/VK_KHR_swapchain/VK_KHR_display)VK_***: Enable Vulkan extensions(same name as each extensions)
Re-exports§
pub use resources::*;pub use SwitchOrDynamicState::*;
Modules§
Macros§
Structs§
- Access
Flags - Access Types
- Attachment
Color Blend State - Structure specifying a pipeline color blend attachment state
- Attachment
Description - Builder structure to construct the
VkAttachmentDescription - Buffer
Memory Barrier - Wrapper object of
VkBufferMemoryBarrier, describes a memory barrier of a buffer. - Command
Buffer - Opaque handle to a command buffer object
- Command
Pool - Opaque handle to a command pool object
- DSLBindings
- Structure specifying a descriptor set layout binding
Tuple Element: (binding index, descriptor count, shader visibility, immutable samplers(if needed)) - Descriptor
Pool - Opaque handle to a descriptor pool object
- Descriptor
Pool Size - Structure specifying descriptor pool size
- Descriptor
SetCopy Info - Structure specifying a copy descriptor set operation
- Descriptor
SetLayout - Opaque handle to a descriptor set layout object
- Descriptor
SetWrite Info - Structure specifying the parameters of a descriptor set write operation Element order: DescriptorSet, Binding, ArrayIndex, Description
- Descriptor
Update Template - Device
- Opaque handle to a device object
- Device
Builder - Builder object for constructing a
Device - Device
Queue Create Info - Family Index, Queue Priorities
- Dynamic
Data Cell - Untyped data cell
- Event
- Opaque handle to a event object
- Extent1D
- Extent2D
- Extent3D
- Extent4D
- Fence
- Opaque handle to a fence object
- Format
Query - Arbitrary queries of Format
- Format
Query Pred - Predication style of Format Selection Query
- Framebuffer
- Opaque handle to a framebuffer object
- Graphics
Pipeline Builder - Builder struct to construct a
Pipelinefor graphics operations - Image
Memory Barrier - Wrapper object of
VkImageMemoryBarrier, derscribes a memory barrier of an image. - Image
Subref - Image Subresource Slice
- Instance
- Opaque handle to a instance object
- Instance
Builder - Builder object for constructing a
Instance - Iter
Physical Devices - Memory
Properties - Device memory properties
- Memory
Property Flags - Bitmask specifying properties for a memory type
- Multisample
State - PipelineStateDesc: Multisample State
- Offset1D
- Offset2D
- Offset3D
- Offset4D
- Physical
Device - Opaque handle to a physical device object
- Pipeline
- Opaque handle to a pipeline object
- Pipeline
Cache - Opaque handle to a pipeline cache object
- Pipeline
Layout - Opaque handle to a pipeline layout object
- Pipeline
Shader - Builder struct to construct a shader stage in a
Pipeline - Pipeline
Stage Flags - Bitmask specifying pipeline stages
- Query
Pipeline Statistic Flags - Bitmask specifying queried pipeline statistics
- Query
Pool - Opaque handle to a query pool object
- Query
Result Flags - Bitmask specifying how and when query results are returned
- Queue
- Opaque handle to a queue object
- Queue
Families - List of queue families
- Queue
Flags - Set of bit of queue flags
- Render
Pass - Opaque handle to a render pass object
- Render
Pass Builder - Builder structure to construct the
RenderPass - Semaphore
- Opaque handle to a semaphore object
- Shader
Module - Opaque handle to a shader module object
- Shader
Stage - Bitmask specifying a pipeline stage
- Sparse
Binding OpBatch - Sparse Binding operation batch
- Submission
Batch - Semaphore/Command submission operation batch
- Subpass
Description - Builder structure to construct the
VkSubpassDescription - Vertex
Processing Stages - PipelineStateDesc: Shader Stages and Input descriptions
- VkResult
Box - Boxed version of
VkResult
Enums§
- Base
Pipeline - Which is pipeline state to derive from
- Blend
Factor - Blending Factor
- BlendOp
- Blending Op
- Clear
Value - The enum representation of
VkClearValue - Compare
Op - Stencil comparison function
- Descriptor
Type - Specified the type of a descriptor in a descriptor set
- Descriptor
Update Info - Structure specifying the parameters of a descriptor set write/copy operations.
- Dynamic
Array State - Whether the state(type of array) is dynamic or static
- Element
Type - Containing component element in format
- Format
Components - Containing Components in Format(Order is not considered)
- Index
Type - Type of index buffer indices
- LoadOp
- LogicOp
- Framebuffer logical operations
- Occlusion
Query - Enabling or disabling the occlusion query
- Query
Type - Specify the type of queries managed by a query pool
- Stencil
Face Mask - Bitmask specifying sets of stencil state for which to update the compare mask
- Stencil
Op - Stencil action function
- StoreOp
- Possible argument values of
AttachmentDescription::store_opandstencil_store_op, specifying how the contents of the attachment are treated. - Switch
OrDynamic State - Disabled, Specified in the command buffer or Specified in the pipeline state
Traits§
- Analog
NumRange - Clear
Color Value - The trait representation of
VkClearColorValue - Device
Child - Child of a device object
- Pixel
Format - For testing format traits
- VkHandle
- Wrapping a Vulkan Dispatchable/Nondispatchable Handler
- VkResult
Handler