Module wgpu::util

Utility structures and functions that are built on top of the main wgpu API.

Nothing in this module is a part of the WebGPU API specification; they are unique to the wgpu library.

Structs

• BufferInitDescriptor
  Describes a Buffer when allocating.
• DispatchIndirectArgs
  Argument buffer layout for dispatch_indirect commands.
• DownloadBuffer
  CPU accessible buffer used to download data back from the GPU.
• DrawIndexedIndirectArgs
  Argument buffer layout for draw_indexed_indirect commands.
• DrawIndirectArgs
  Argument buffer layout for draw_indirect commands.
• StagingBelt
  Efficiently performs many buffer writes by sharing and reusing temporary buffers.

Enums

• TextureDataOrder
  Order in which TextureData is laid out in memory.

Traits

• DeviceExt
  Utility methods not meant to be in the main API.
• RenderEncoder
  Methods shared by RenderPass and RenderBundleEncoder.

Functions

• align_to
  Aligns a value to an alignment.
• backend_bits_from_env
  Get a set of backend bits from the environment variable WGPU_BACKEND.
• dx12_shader_compiler_from_env
  Choose which DX12 shader compiler to use from the environment variable WGPU_DX12_COMPILER.
• gles_minor_version_from_env
  Choose which minor OpenGL ES version to use from the environment variable WGPU_GLES_MINOR_VERSION.
• initialize_adapter_from_env
  Initialize the adapter obeying the WGPU_ADAPTER_NAME environment variable.
• initialize_adapter_from_env_or_default
  Initialize the adapter obeying the WGPU_ADAPTER_NAME environment variable and if it doesn’t exist fall back on a default adapter.
• instance_descriptor_from_env
  Get an instance descriptor from the following environment variables:
• is_browser_webgpu_supported
  Determines whether the Backends::BROWSER_WEBGPU backend is supported.
• make_spirv_raw
  Version of make_spirv intended for use with Device::create_shader_module_spirv. Returns raw slice instead of ShaderSource.
• new_instance_with_webgpu_detection
  Create an new instance of wgpu, but disabling Backends::BROWSER_WEBGPU if no WebGPU support was detected.
• parse_backends_from_comma_list
  Generates a set of backends from a comma separated list of case-insensitive backend names.
• pipeline_cache_key
  A recommended key for storing PipelineCaches for the adapter associated with the given AdapterInfo This key will define a class of adapters for which the same cache might be valid.
• power_preference_from_env
  Get a power preference from the environment variable WGPU_POWER_PREF