Crate bedrock [] [src]

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

resources

Vulkan Resources

traits

All of traits

vk

Vulkan API Definitions 1.1.70.1

Macros

DescriptorUpdateTemplateEntries
DescriptorUpdateTemplateEntry
VK_MAKE_VERSION
VK_VERSION

Structs

AccessFlags

Access Types

AttachmentColorBlendState

Structure specifying a pipeline color blend attachment state

AttachmentDescription

Builder structure to construct the VkAttachmentDescription

BufferMemoryBarrier

Wrapper object of VkBufferMemoryBarrier, describes a memory barrier of a buffer.

CommandBuffer

Opaque handle to a command buffer object

CommandPool

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))

DescriptorPool

Opaque handle to a descriptor pool object

DescriptorPoolSize

Structure specifying descriptor pool size

DescriptorSetCopyInfo

Structure specifying a copy descriptor set operation

DescriptorSetLayout

Opaque handle to a descriptor set layout object

DescriptorSetWriteInfo

Structure specifying the parameters of a descriptor set write operation Element order: DescriptorSet, Binding, ArrayIndex, Description

DescriptorUpdateTemplate
Device

Opaque handle to a device object

DeviceBuilder

Builder object for constructing a Device

DeviceQueueCreateInfo

Family Index, Queue Priorities

DynamicDataCell

Untyped data cell

Event

Opaque handle to a event object

Extent1D
Extent2D
Extent3D
Extent4D
Fence

Opaque handle to a fence object

FormatQuery

Arbitrary queries of Format

FormatQueryPred

Predication style of Format Selection Query

Framebuffer

Opaque handle to a framebuffer object

GraphicsPipelineBuilder

Builder struct to construct a Pipeline for graphics operations

ImageMemoryBarrier

Wrapper object of VkImageMemoryBarrier, derscribes a memory barrier of an image.

ImageSubref

Image Subresource Slice

Instance

Opaque handle to a instance object

InstanceBuilder

Builder object for constructing a Instance

IterPhysicalDevices
MemoryProperties

Device memory properties

MemoryPropertyFlags

Bitmask specifying properties for a memory type

MultisampleState

PipelineStateDesc: Multisample State

Offset1D
Offset2D
Offset3D
Offset4D
PhysicalDevice

Opaque handle to a physical device object

Pipeline

Opaque handle to a pipeline object

PipelineCache

Opaque handle to a pipeline cache object

PipelineLayout

Opaque handle to a pipeline layout object

PipelineShader

Builder struct to construct a shader stage in a Pipeline

PipelineStageFlags

Bitmask specifying pipeline stages

QueryPipelineStatisticFlags

Bitmask specifying queried pipeline statistics

QueryPool

Opaque handle to a query pool object

QueryResultFlags

Bitmask specifying how and when query results are returned

Queue

Opaque handle to a queue object

QueueFamilies

List of queue families

QueueFlags

Set of bit of queue flags

RenderPass

Opaque handle to a render pass object

RenderPassBuilder

Builder structure to construct the RenderPass

Semaphore

Opaque handle to a semaphore object

ShaderModule

Opaque handle to a shader module object

ShaderStage

Bitmask specifying a pipeline stage

SparseBindingOpBatch

Sparse Binding operation batch

SubmissionBatch

Semaphore/Command submission operation batch

SubpassDescription

Builder structure to construct the VkSubpassDescription

VertexProcessingStages

PipelineStateDesc: Shader Stages and Input descriptions

VkResultBox

Boxed version of VkResult

Enums

BasePipeline

Which is pipeline state to derive from

BlendFactor

Blending Factor

BlendOp

Blending Op

ClearValue

The enum representation of VkClearValue

CompareOp

Stencil comparison function

DescriptorType

Specified the type of a descriptor in a descriptor set

DescriptorUpdateInfo

Structure specifying the parameters of a descriptor set write/copy operations.

DynamicArrayState

Whether the state(type of array) is dynamic or static

ElementType

Containing component element in format

FormatComponents

Containing Components in Format(Order is not considered)

IndexType

Type of index buffer indices

LoadOp
LogicOp

Framebuffer logical operations

OcclusionQuery

Enabling or disabling the occlusion query

QueryType

Specify the type of queries managed by a query pool

StencilFaceMask

Bitmask specifying sets of stencil state for which to update the compare mask

StencilOp

Stencil action function

StoreOp

Possible argument values of AttachmentDescription::store_op and stencil_store_op, specifying how the contents of the attachment are treated.

SwitchOrDynamicState

Disabled, Specified in the command buffer or Specified in the pipeline state

Traits

AnalogNumRange
ClearColorValue

The trait representation of VkClearColorValue

DeviceChild

Child of a device object

PixelFormat

For testing format traits

VkHandle

Wrapping a Vulkan Dispatchable/Nondispatchable Handler

VkResultHandler

Type Definitions

Result