wgpu.api

Members

Aliases

AdapterInfo

alias AdapterInfo = WGPUCAdapterInfo

Metadata about a backend adapter.

BindGroupDescriptor

alias BindGroupDescriptor = WGPUBindGroupDescriptor

Describes a BindGroup.

BindGroupLayoutDescriptor

alias BindGroupLayoutDescriptor = WGPUBindGroupLayoutDescriptor

Describes a BindGroupLayout.

BindGroupLayoutEntry

alias BindGroupLayoutEntry = WGPUBindGroupLayoutEntry

Describes a single binding inside a bind group.

BufferAddress

alias BufferAddress = WGPUBufferAddress

Integral type used for buffer offsets.

BufferCopyView

alias BufferCopyView = WGPUBufferCopyView

View of a buffer which can be used to copy to/from a texture.

BufferDescriptor

alias BufferDescriptor = WGPUBufferDescriptor

Describes a Buffer.

Color

alias Color = WGPUColor

RGBA double precision color.

CommandBufferDescriptor

alias CommandBufferDescriptor = WGPUCommandBufferDescriptor

Describes a CommandBuffer.

CommandEncoderDescriptor

alias CommandEncoderDescriptor = WGPUCommandEncoderDescriptor

Describes a CommandEncoder.

ComputePassDescriptor

alias ComputePassDescriptor = WGPUComputePassDescriptor

Describes a ComputePass.

ComputePipelineDescriptor

alias ComputePipelineDescriptor = WGPUComputePipelineDescriptor

Describes a ComputePipeline.

Extent3d

alias Extent3d = WGPUExtent3d

Extent of a texture related operation.

Features

alias Features = WGPUFeatures

Features that are not guaranteed to be supported.

Limits

alias Limits = WGPUCLimits

Represents the sets of limits an adapter/device supports.

Origin3d

alias Origin3d = WGPUOrigin3d

Origin of a copy to/from a texture.

PassChannel_Color

alias PassChannel_Color = WGPUPassChannel_Color

Undocumented in source.

PipelineLayoutDescriptor

alias PipelineLayoutDescriptor = WGPUPipelineLayoutDescriptor

Describes a PipelineLayout.

RenderPassColorAttachmentDescriptor

alias RenderPassColorAttachmentDescriptor = WGPURenderPassColorAttachmentDescriptor

Describes a color attachment to a RenderPass.

RenderPassDescriptor

alias RenderPassDescriptor = WGPURenderPassDescriptor

Describes a RenderPass.

RenderPipelineDescriptor

alias RenderPipelineDescriptor = WGPURenderPipelineDescriptor

Describes a RenderPipeline.

RequestAdapterOptions

alias RequestAdapterOptions = WGPURequestAdapterOptions

Undocumented in source.

SamplerDescriptor

alias SamplerDescriptor = WGPUSamplerDescriptor

Describes a Sampler.

SwapChainDescriptor

alias SwapChainDescriptor = WGPUSwapChainDescriptor

Describes a SwapChain.

TextureCopyView

alias TextureCopyView = WGPUTextureCopyView

View of a texture which can be used to copy to/from a buffer/texture.

TextureDataLayout

alias TextureDataLayout = WGPUTextureDataLayout

Layout of a texture in a buffer's memory.

TextureDescriptor

alias TextureDescriptor = WGPUTextureDescriptor

Describes a Texture.

TextureViewDescriptor

alias TextureViewDescriptor = WGPUTextureViewDescriptor

Describes a TextureView.

WgpuId

alias WgpuId = c_ulong

Undocumented in source.

Enums

BufferMapAsyncStatus

enum BufferMapAsyncStatus

Result of a call to Buffer.mapReadAsync or Buffer.mapWriteAsync.

BufferUsage

enum BufferUsage

Different ways that you can use a buffer.

ShaderStage

enum ShaderStage

Describes the shader stages that a binding will be visible from.

SwapChainError

enum SwapChainError

Result of an unsuccessful call to SwapChain.getNextTexture.

TextureUsage

enum TextureUsage

Different ways that you can use a texture.

Imports

AddressMode (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

Backend (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

BindingType (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

BlendFactor (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

BlendOperation (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

CDeviceType (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

CompareFunction (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

CullMode (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

FilterMode (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

FrontFace (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

IndexFormat (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

InputStepMode (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

LoadOp (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

LogLevel (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

PowerPreference (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

PresentMode (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

PrimitiveTopology (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

SType (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

StencilOperation (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

StoreOp (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

SwapChainStatus (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

TextureAspect (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

TextureComponentType (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

TextureDimension (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

TextureFormat (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

TextureViewDimension (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

VertexFormat (from wgpu.bindings)

public import wgpu.bindings : AddressMode, Backend, BindingType, BlendFactor, BlendOperation, CDeviceType, CompareFunction, CullMode, FilterMode, FrontFace, IndexFormat, InputStepMode, LoadOp, LogLevel, PowerPreference, PresentMode, PrimitiveTopology, SType, StencilOperation, StoreOp, SwapChainStatus, TextureAspect, TextureComponentType, TextureDimension, TextureFormat, TextureViewDimension, VertexFormat;

Undocumented in source.

Static variables

COPY_BYTES_PER_ROW_ALIGNMENT

auto COPY_BYTES_PER_ROW_ALIGNMENT;

Buffer-Texture copies must have bytes_per_row aligned to this number.

DESIRED_NUM_FRAMES

auto DESIRED_NUM_FRAMES;

Unknown

MAX_ANISOTROPY

auto MAX_ANISOTROPY;

Maximum anisotropy.

MAX_COLOR_TARGETS

auto MAX_COLOR_TARGETS;

Maximum number of color targets.

MAX_MIP_LEVELS

auto MAX_MIP_LEVELS;

Maximum amount of mipmap levels.

MAX_VERTEX_BUFFERS

auto MAX_VERTEX_BUFFERS;

Maximum number of vertex buffers.

VERSION

auto VERSION;

Version of <a href="https://github.com/gfx-rs/wgpu-native">wgpu-native</a> this library binds.

Structs

Adapter

struct Adapter

A handle to a physical graphics and/or compute device.

BindGroup

struct BindGroup

An opaque handle to a binding group.

BindGroupLayout

struct BindGroupLayout

An opaque handle to a binding group layout.

Buffer

struct Buffer

A handle to a GPU-accessible buffer.

CommandBuffer

struct CommandBuffer

An opaque handle to a command buffer on the GPU.

CommandEncoder

struct CommandEncoder

An object that encodes GPU operations.

ComputePass

struct ComputePass

An in-progress recording of a compute pass.

ComputePipeline

struct ComputePipeline

A handle to a compute pipeline.

Device

struct Device

An open connection to a graphics and/or compute device.

PipelineLayout

struct PipelineLayout

An opaque handle to a pipeline layout.

Queue

struct Queue

A Queue executes finished CommandBuffer objects.

RenderPass

struct RenderPass

An in-progress recording of a render pass.

RenderPipeline

struct RenderPipeline

A handle to a rendering (graphics) pipeline.

Sampler

struct Sampler

A handle to a sampler.

ShaderModule

struct ShaderModule

A handle to a compiled shader module.

Surface

struct Surface

A handle to a presentable surface.

SwapChain

struct SwapChain

A handle to a swap chain.

SwapChainOutput

struct SwapChainOutput

Result of a call to SwapChain.getNextTexture.

Texture

struct Texture

A handle to a texture on the GPU.

TextureView

struct TextureView

A handle to a texture view.

• api
• bindings