128 lines
4.2 KiB
Rust
128 lines
4.2 KiB
Rust
//! A cross-platform graphics and compute library based on [WebGPU](https://gpuweb.github.io/gpuweb/).
|
|
//!
|
|
//! To start using the API, create an [`Instance`].
|
|
//!
|
|
//! ## Feature flags
|
|
#![doc = document_features::document_features!()]
|
|
//!
|
|
//! ### Feature Aliases
|
|
//!
|
|
//! These features aren't actually features on the crate itself, but a convenient shorthand for
|
|
//! complicated cases.
|
|
//!
|
|
//! - **`wgpu_core`** --- Enabled when there is any non-webgpu backend enabled on the platform.
|
|
//! - **`naga`** ---- Enabled when any non-wgsl shader input is enabled.
|
|
//!
|
|
|
|
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
|
|
#![doc(html_logo_url = "https://raw.githubusercontent.com/gfx-rs/wgpu/trunk/logo.png")]
|
|
#![warn(
|
|
clippy::allow_attributes,
|
|
missing_docs,
|
|
rust_2018_idioms,
|
|
unsafe_op_in_unsafe_fn
|
|
)]
|
|
#![allow(clippy::arc_with_non_send_sync)]
|
|
#![cfg_attr(not(any(wgpu_core, webgpu)), allow(unused))]
|
|
|
|
//
|
|
//
|
|
// Modules
|
|
//
|
|
//
|
|
|
|
mod api;
|
|
mod backend;
|
|
mod cmp;
|
|
mod dispatch;
|
|
mod macros;
|
|
pub mod util;
|
|
|
|
//
|
|
//
|
|
// Private re-exports
|
|
//
|
|
//
|
|
|
|
//
|
|
//
|
|
// Public re-exports
|
|
//
|
|
//
|
|
|
|
pub use api::*;
|
|
pub use wgt::{
|
|
AdapterInfo, AddressMode, AstcBlock, AstcChannel, Backend, BackendOptions, Backends,
|
|
BindGroupLayoutEntry, BindingType, BlendComponent, BlendFactor, BlendOperation, BlendState,
|
|
BufferAddress, BufferBindingType, BufferSize, BufferUsages, Color, ColorTargetState,
|
|
ColorWrites, CommandBufferDescriptor, CompareFunction, CompositeAlphaMode,
|
|
CopyExternalImageDestInfo, CoreCounters, DepthBiasState, DepthStencilState, DeviceLostReason,
|
|
DeviceType, DownlevelCapabilities, DownlevelFlags, Dx12BackendOptions, Dx12Compiler,
|
|
DynamicOffset, Extent3d, Face, Features, FilterMode, FrontFace, GlBackendOptions,
|
|
Gles3MinorVersion, HalCounters, ImageSubresourceRange, IndexFormat, InstanceDescriptor,
|
|
InstanceFlags, InternalCounters, Limits, MaintainResult, MemoryHints, MultisampleState,
|
|
Origin2d, Origin3d, PipelineStatisticsTypes, PolygonMode, PowerPreference,
|
|
PredefinedColorSpace, PresentMode, PresentationTimestamp, PrimitiveState, PrimitiveTopology,
|
|
PushConstantRange, QueryType, RenderBundleDepthStencil, SamplerBindingType, SamplerBorderColor,
|
|
ShaderLocation, ShaderModel, ShaderRuntimeChecks, ShaderStages, StencilFaceState,
|
|
StencilOperation, StencilState, StorageTextureAccess, SurfaceCapabilities, SurfaceStatus,
|
|
TexelCopyBufferLayout, TextureAspect, TextureDimension, TextureFormat,
|
|
TextureFormatFeatureFlags, TextureFormatFeatures, TextureSampleType, TextureUsages,
|
|
TextureViewDimension, VertexAttribute, VertexFormat, VertexStepMode, WasmNotSend,
|
|
WasmNotSendSync, WasmNotSync, COPY_BUFFER_ALIGNMENT, COPY_BYTES_PER_ROW_ALIGNMENT,
|
|
MAP_ALIGNMENT, PUSH_CONSTANT_ALIGNMENT, QUERY_RESOLVE_BUFFER_ALIGNMENT, QUERY_SET_MAX_QUERIES,
|
|
QUERY_SIZE, VERTEX_STRIDE_ALIGNMENT,
|
|
};
|
|
#[expect(deprecated)]
|
|
pub use wgt::{ImageCopyBuffer, ImageCopyTexture, ImageCopyTextureTagged, ImageDataLayout};
|
|
// wasm-only types, we try to keep as many types non-platform
|
|
// specific, but these need to depend on web-sys.
|
|
#[cfg(any(webgpu, webgl))]
|
|
#[expect(deprecated)]
|
|
pub use wgt::ImageCopyExternalImage;
|
|
#[cfg(any(webgpu, webgl))]
|
|
pub use wgt::{CopyExternalImageSourceInfo, ExternalImageSource};
|
|
//
|
|
//
|
|
// Re-exports of dependencies
|
|
//
|
|
//
|
|
|
|
/// Re-export of our `wgpu-core` dependency.
|
|
///
|
|
#[cfg(wgpu_core)]
|
|
pub use ::wgc as core;
|
|
|
|
/// Re-export of our `wgpu-hal` dependency.
|
|
///
|
|
///
|
|
#[cfg(wgpu_core)]
|
|
pub use ::hal;
|
|
|
|
/// Re-export of our `naga` dependency.
|
|
///
|
|
#[cfg(wgpu_core)]
|
|
#[cfg_attr(docsrs, doc(cfg(any(wgpu_core, naga))))]
|
|
// We re-export wgpu-core's re-export of naga, as we may not have direct access to it.
|
|
pub use ::wgc::naga;
|
|
/// Re-export of our `naga` dependency.
|
|
///
|
|
#[cfg(all(not(wgpu_core), naga))]
|
|
#[cfg_attr(docsrs, doc(cfg(any(wgpu_core, naga))))]
|
|
// If that's not available, we re-export our own.
|
|
pub use naga;
|
|
|
|
/// Re-export of our `raw-window-handle` dependency.
|
|
///
|
|
pub use raw_window_handle as rwh;
|
|
|
|
/// Re-export of our `web-sys` dependency.
|
|
///
|
|
#[cfg(any(webgl, webgpu))]
|
|
pub use web_sys;
|
|
|
|
/// `web-sys` has a `no_std` mode, and instead refers to the `alloc` crate in its generated code.
|
|
/// Since we vendor the WebGPU bindings we need to explicitly add the `alloc` crate ourselves.
|
|
#[cfg(webgpu)]
|
|
extern crate alloc;
|