[−][src]Crate wgpu
A cross-platform graphics and compute library based on WebGPU.
To start using the API, create an Instance
.
Modules
util | Utility structures and functions. |
Macros
include_spirv | Macro to load a SPIR-V module statically. |
vertex_attr_array | Macro to produce an array of [ |
Structs
Adapter | Handle to a physical graphics and/or compute device. |
AdapterInfo | Metadata about a backend adapter. |
BackendBit | Represents the backends that wgpu will use. |
BindGroup | Handle to a binding group. |
BindGroupDescriptor | Describes a group of bindings and the resources to be bound. |
BindGroupEntry | Bindable resource and the slot to bind it to. |
BindGroupLayout | Handle to a binding group layout. |
BindGroupLayoutDescriptor | Describes a |
BindGroupLayoutEntry | Describes a single binding inside a bind group. |
BlendDescriptor | Describes the blend state of a pipeline. |
Buffer | Handle to a GPU-accessible buffer. |
BufferAsyncError | Error occurred when trying to async map a buffer. |
BufferCopyViewBase | View of a buffer which can be used to copy to/from a texture. |
BufferDescriptor | Describes a |
BufferSlice | Slice into a |
BufferUsage | Different ways that you can use a buffer. |
BufferView | Read only view into a mapped buffer. |
BufferViewMut | Write only view into mapped buffer. |
Color | RGBA double precision color. |
ColorStateDescriptor | Describes the color state of a render pipeline. |
ColorWrite | Color write mask. Disabled color channels will not be written to. |
CommandBuffer | Handle to a command buffer on the GPU. |
CommandBufferDescriptor | Describes a [ |
CommandEncoder | Encodes a series of GPU operations. |
CommandEncoderDescriptor | Describes a |
ComputePass | In-progress recording of a compute pass. |
ComputePipeline | Handle to a compute pipeline. |
ComputePipelineDescriptor | Describes a compute pipeline. |
DepthStencilStateDescriptor | Describes the depth/stencil state in a render pipeline. |
Device | Open connection to a graphics and/or compute device. |
DeviceDescriptor | Describes a [ |
Extent3d | Extent of a texture related operation. |
Features | Features that are not guaranteed to be supported. |
Instance | Context for all other wgpu objects. Instance of wgpu. |
Limits | Represents the sets of limits an adapter/device supports. |
Operations | Pair of load and store operations for an attachment aspect. |
Origin3d | Origin of a copy to/from a texture. |
PipelineLayout | Handle to a pipeline layout. |
PipelineLayoutDescriptor | Describes a pipeline layout. |
ProgrammableStageDescriptor | Describes a programmable pipeline stage. |
PushConstantRange | A range of push constant memory to pass to a shader stage. |
Queue | Handle to a command queue on a device. |
RasterizationStateDescriptor | Describes the state of the rasterizer in a render pipeline. |
RenderBundle | Pre-prepared reusable bundle of GPU operations. |
RenderBundleDescriptor | Describes a |
RenderBundleEncoder | Encodes a series of GPU operations into a reusable "render bundle". |
RenderBundleEncoderDescriptor | Describes a |
RenderPass | In-progress recording of a render pass. |
RenderPassColorAttachmentDescriptor | Describes a color attachment to a |
RenderPassDepthStencilAttachmentDescriptor | Describes a depth/stencil attachment to a |
RenderPassDescriptor | Describes the attachments of a render pass. |
RenderPipeline | Handle to a rendering (graphics) pipeline. |
RenderPipelineDescriptor | Describes a render (graphics) pipeline. |
RequestAdapterOptionsBase | Options for requesting adapter. |
RequestDeviceError | Requesting a device failed. |
Sampler | Handle to a sampler. |
SamplerDescriptor | Describes a |
ShaderModule | Handle to a compiled shader module. |
ShaderStage | Describes the shader stages that a binding will be visible from. |
StencilStateDescriptor | |
StencilStateFaceDescriptor | Describes stencil state in a render pipeline. |
Surface | Handle to a presentable surface. |
SwapChain | Handle to a swap chain. |
SwapChainDescriptor | Describes a [ |
SwapChainFrame | Result of a successful call to |
SwapChainTexture | Swap chain image that can be rendered to. |
Texture | Handle to a texture on the GPU. |
TextureCopyViewBase | View of a texture which can be used to copy to/from a buffer/texture. |
TextureDataLayout | Layout of a texture in a buffer's memory. |
TextureDescriptor | Describes a |
TextureUsage | Different ways that you can use a texture. |
TextureView | Handle to a texture view. |
TextureViewDescriptor | Describes a |
VertexAttributeDescriptor | Vertex inputs (attributes) to shaders. |
VertexBufferDescriptor | Describes how the vertex buffer is interpreted. |
VertexStateDescriptor | Describes vertex input state for a render pipeline. |
Enums
AddressMode | How edges should be handled in texture addressing. |
Backend | Backends supported by wgpu. |
BindingResource | Resource that can be bound to a pipeline. |
BindingType | Specific type of a binding. |
BlendFactor | Alpha blend factor. |
BlendOperation | Alpha blend operation. |
CompareFunction | Comparison function used for depth and stencil operations. |
CullMode | Type of faces to be culled. |
DeviceType | Supported physical device types. |
FilterMode | Texel mixing mode when sampling between texels. |
FrontFace | Winding order which classifies the "front" face. |
IndexFormat | Format of indices used with pipeline. |
InputStepMode | Rate that determines when vertex data is advanced. |
LoadOp | Operation to perform to the output attachment at the start of a renderpass. |
Maintain | Passed to |
MapMode | Type of buffer mapping. |
PowerPreference | Power Preference when choosing a physical adapter. |
PresentMode | Behavior of the presentation engine based on frame rate. |
PrimitiveTopology | Primitive type the input mesh is composed of. |
ShaderModuleSource | Source of a shader module. |
StencilOperation | Operation to perform on the stencil value. |
SwapChainError | Result of an unsuccessful call to |
SwapChainStatus | Status of the recieved swapchain image. |
TextureAspect | Kind of data the texture holds. |
TextureComponentType | Type of data shaders will read from a texture. |
TextureDimension | Dimensionality of a texture. |
TextureFormat | Underlying texture data format. |
TextureViewDimension | Dimensions of a particular texture view. |
VertexFormat | Vertex Format for a Vertex Attribute (input). |
Constants
BIND_BUFFER_ALIGNMENT | Bound uniform/storage buffer offsets must be aligned to this number. |
COPY_BUFFER_ALIGNMENT | Buffer to buffer copy offsets and sizes must be aligned to this number. |
COPY_BYTES_PER_ROW_ALIGNMENT | Buffer-Texture copies must have |
PUSH_CONSTANT_ALIGNMENT | Alignment all push constants need |
Type Definitions
BufferAddress | Integral type used for buffer offsets. |
BufferCopyView | View of a buffer which can be used to copy to/from a texture. |
BufferSize | Integral type used for buffer slice sizes. |
DynamicOffset | Integral type used for dynamic bind group offsets. |
RequestAdapterOptions | Additional information required when requesting an adapter. |
ShaderLocation | Integral type used for binding locations in shaders. |
TextureCopyView | View of a texture which can be used to copy to/from a buffer/texture. |