mirror of
https://github.com/storytold/wgpu.git
synced 2026-11-22 07:21:04 +01:00
Revert part of #10115 by removing result from create_render_bundle_encoder and reimpl content validation in deno (#10179)
This commit is contained in:
16 files changed
+100
-129
No files matched your search
@@ -82,17 +82,6 @@ By @beicause in [#9553](https://github.com/gfx-rs/wgpu/pull/9553).
|
||||
|
||||
By @sagudev in [#10109](https://github.com/gfx-rs/wgpu/pull/10109).
|
||||
|
||||
#### `Device::create_render_bundle_encoder` now returns error
|
||||
|
||||
Error is raised if for provided texture formats required features are not enabled on the device as per spec.
|
||||
|
||||
```diff
|
||||
- device.create_render_bundle_encoder(&RenderBundleEncoderDescriptor::default())
|
||||
+ device.create_render_bundle_encoder(&RenderBundleEncoderDescriptor::default()).unwrap()
|
||||
```
|
||||
|
||||
By @sagudev in [#10115](https://github.com/gfx-rs/wgpu/pull/10115).
|
||||
|
||||
### Added/New Features
|
||||
|
||||
#### General
|
||||
|
||||
+28
-5
@@ -63,6 +63,22 @@ pub struct GPUDevice {
|
||||
pub(crate) weak: std::sync::OnceLock<v8::Weak<v8::Object>>,
|
||||
}
|
||||
|
||||
impl GPUDevice {
|
||||
/// <https://www.w3.org/TR/webgpu/#abstract-opdef-validate-texture-format-required-features>
|
||||
fn validate_texture_format_required_feature(
|
||||
&self,
|
||||
format: wgpu_types::TextureFormat,
|
||||
) -> Result<(), JsErrorBox> {
|
||||
self
|
||||
.wgpu_device
|
||||
.require_features(format.required_features())
|
||||
.map_err(|err| {
|
||||
let err = fmt_err(&err);
|
||||
JsErrorBox::type_error(err)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl WebIdlInterfaceConverter for GPUDevice {
|
||||
const NAME: &'static str = "GPUDevice";
|
||||
}
|
||||
@@ -649,13 +665,20 @@ impl GPUDevice {
|
||||
multiview: None,
|
||||
};
|
||||
|
||||
// 1. Validate texture format required features of each non-null element of descriptor.colorFormats with this.[[device]].
|
||||
for &format in wgpu_descriptor.color_formats.iter().flatten() {
|
||||
self.validate_texture_format_required_feature(format)?;
|
||||
}
|
||||
|
||||
// 2. If descriptor.depthStencilFormat is provided:
|
||||
if let Some(ds) = wgpu_descriptor.depth_stencil {
|
||||
// Validate texture format required features of descriptor.depthStencilFormat with this.[[device]].
|
||||
self.validate_texture_format_required_feature(ds.format)?;
|
||||
}
|
||||
|
||||
let encoder = self
|
||||
.wgpu_device
|
||||
.create_render_bundle_encoder(&wgpu_descriptor)
|
||||
.map_err(|err| {
|
||||
let err = fmt_err(&err);
|
||||
JsErrorBox::type_error(err)
|
||||
})?;
|
||||
.create_render_bundle_encoder(&wgpu_descriptor);
|
||||
|
||||
Ok(GPURenderBundleEncoder {
|
||||
encoder: RefCell::new(encoder),
|
||||
|
||||
@@ -80,15 +80,14 @@ impl Example {
|
||||
multiview_mask: None,
|
||||
cache: None,
|
||||
});
|
||||
let mut encoder = device
|
||||
.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
let mut encoder =
|
||||
device.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
label: None,
|
||||
color_formats: &[Some(config.view_formats[0])],
|
||||
depth_stencil: None,
|
||||
sample_count,
|
||||
multiview: None,
|
||||
})
|
||||
.unwrap();
|
||||
});
|
||||
encoder.set_pipeline(&pipeline);
|
||||
encoder.set_vertex_buffer(0, vertex_buffer.slice(..));
|
||||
encoder.draw(0..vertex_count, 0..1);
|
||||
|
||||
@@ -610,8 +610,8 @@ impl crate::framework::Example for Example {
|
||||
|
||||
// A render bundle to draw the terrain.
|
||||
let terrain_bundle = {
|
||||
let mut encoder = device
|
||||
.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
let mut encoder =
|
||||
device.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
label: None,
|
||||
color_formats: &[Some(config.view_formats[0])],
|
||||
depth_stencil: Some(wgpu::RenderBundleDepthStencil {
|
||||
@@ -621,8 +621,7 @@ impl crate::framework::Example for Example {
|
||||
}),
|
||||
sample_count: 1,
|
||||
multiview: None,
|
||||
})
|
||||
.unwrap();
|
||||
});
|
||||
encoder.set_pipeline(&terrain_pipeline);
|
||||
encoder.set_bind_group(0, &terrain_flipped_bind_group, &[]);
|
||||
encoder.set_vertex_buffer(0, terrain_vertex_buf.slice(..));
|
||||
|
||||
@@ -247,8 +247,7 @@ impl DeviceInterface for CustomDevice {
|
||||
fn create_render_bundle_encoder(
|
||||
&self,
|
||||
_desc: &wgpu::RenderBundleEncoderDescriptor<'_>,
|
||||
) -> Result<wgpu::custom::DispatchRenderBundleEncoder, wgpu::CreateRenderBundleEncoderError>
|
||||
{
|
||||
) -> wgpu::custom::DispatchRenderBundleEncoder {
|
||||
unimplemented!()
|
||||
}
|
||||
|
||||
|
||||
@@ -344,14 +344,13 @@ async fn render_pass_test(ctx: &TestingContext, use_render_bundle: bool) {
|
||||
let mut render_pass = command_encoder.begin_render_pass(&render_pass_desc);
|
||||
if use_render_bundle {
|
||||
// Execute the commands in a render_bundle_encoder.
|
||||
let mut render_bundle_encoder = ctx
|
||||
.device
|
||||
.create_render_bundle_encoder(&RenderBundleEncoderDescriptor {
|
||||
color_formats: &[Some(output_texture.format())],
|
||||
sample_count: 1,
|
||||
..RenderBundleEncoderDescriptor::default()
|
||||
})
|
||||
.unwrap();
|
||||
let mut render_bundle_encoder =
|
||||
ctx.device
|
||||
.create_render_bundle_encoder(&RenderBundleEncoderDescriptor {
|
||||
color_formats: &[Some(output_texture.format())],
|
||||
sample_count: 1,
|
||||
..RenderBundleEncoderDescriptor::default()
|
||||
});
|
||||
do_encoding(&mut render_bundle_encoder, &pipeline, &bind_group, &data);
|
||||
let render_bundle = render_bundle_encoder.finish(&RenderBundleDescriptor::default());
|
||||
render_pass.execute_bundles([&render_bundle]);
|
||||
|
||||
@@ -310,16 +310,15 @@ fn record_encoder_with_resource(
|
||||
pass.set_bind_group(0, &bind_group, &[]);
|
||||
pass.draw(0..0, 0..0);
|
||||
} else {
|
||||
let mut rbe = ctx
|
||||
.device
|
||||
.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
label: None,
|
||||
color_formats: &[Some(wgpu::TextureFormat::Rgba8Unorm)],
|
||||
depth_stencil: None,
|
||||
sample_count: 1,
|
||||
multiview: None,
|
||||
})
|
||||
.unwrap();
|
||||
let mut rbe =
|
||||
ctx.device
|
||||
.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
label: None,
|
||||
color_formats: &[Some(wgpu::TextureFormat::Rgba8Unorm)],
|
||||
depth_stencil: None,
|
||||
sample_count: 1,
|
||||
multiview: None,
|
||||
});
|
||||
rbe.set_pipeline(&pipeline);
|
||||
rbe.set_bind_group(0, &bind_group, &[]);
|
||||
rbe.draw(0..0, 0..0);
|
||||
@@ -1025,16 +1024,15 @@ fn test_replaced_bind_group(ctx: &TestingContext, usage: UsageKind) {
|
||||
pass.set_bind_group(0, &bind_group_b, &[]);
|
||||
pass.draw(0..0, 0..0);
|
||||
} else {
|
||||
let mut rbe = ctx
|
||||
.device
|
||||
.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
label: None,
|
||||
color_formats: &[Some(wgpu::TextureFormat::Rgba8Unorm)],
|
||||
depth_stencil: None,
|
||||
sample_count: 1,
|
||||
multiview: None,
|
||||
})
|
||||
.unwrap();
|
||||
let mut rbe =
|
||||
ctx.device
|
||||
.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
label: None,
|
||||
color_formats: &[Some(wgpu::TextureFormat::Rgba8Unorm)],
|
||||
depth_stencil: None,
|
||||
sample_count: 1,
|
||||
multiview: None,
|
||||
});
|
||||
rbe.set_pipeline(&pipeline);
|
||||
rbe.set_bind_group(0, &bind_group_a, &[]);
|
||||
rbe.set_bind_group(0, &bind_group_b, &[]);
|
||||
|
||||
@@ -375,17 +375,15 @@ async fn vertex_index_common(ctx: TestingContext) {
|
||||
// (it is dropped via `take` + `finish` earlier, but compiler does not take this into account)
|
||||
let mut render_bundle_encoder = match test.encoder_kind {
|
||||
EncoderKind::RenderPass => None,
|
||||
EncoderKind::RenderBundle => Some(
|
||||
ctx.device
|
||||
.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
label: Some("test renderbundle encoder"),
|
||||
color_formats: &[Some(wgpu::TextureFormat::Rgba8Unorm)],
|
||||
depth_stencil: None,
|
||||
sample_count: 1,
|
||||
multiview: None,
|
||||
})
|
||||
.unwrap(),
|
||||
),
|
||||
EncoderKind::RenderBundle => Some(ctx.device.create_render_bundle_encoder(
|
||||
&wgpu::RenderBundleEncoderDescriptor {
|
||||
label: Some("test renderbundle encoder"),
|
||||
color_formats: &[Some(wgpu::TextureFormat::Rgba8Unorm)],
|
||||
depth_stencil: None,
|
||||
sample_count: 1,
|
||||
multiview: None,
|
||||
},
|
||||
)),
|
||||
};
|
||||
|
||||
let render_encoder: &mut dyn RenderEncoder = render_bundle_encoder
|
||||
|
||||
@@ -537,13 +537,12 @@ fn render_multi_immediates_auto_layout_with_all_immediates_set_succeeds() {
|
||||
wgpu_test::valid(&device, || encoder.finish());
|
||||
|
||||
let mut encoder = device.create_command_encoder(&Default::default());
|
||||
let mut bundle_encoder = device
|
||||
.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
let mut bundle_encoder =
|
||||
device.create_render_bundle_encoder(&wgpu::RenderBundleEncoderDescriptor {
|
||||
color_formats: &[Some(output_texture_view.texture().format())],
|
||||
sample_count: 1,
|
||||
..wgpu::RenderBundleEncoderDescriptor::default()
|
||||
})
|
||||
.unwrap();
|
||||
});
|
||||
do_encoding(&mut bundle_encoder, &pipeline);
|
||||
let bundle = bundle_encoder.finish(&wgpu::RenderBundleDescriptor::default());
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ use wgpu_core_remote_types::{
|
||||
use wgpu_core::{
|
||||
binding_model::{self},
|
||||
command,
|
||||
device::{DeviceLostClosure, MissingFeatures, WaitIdleError},
|
||||
device::{DeviceLostClosure, WaitIdleError},
|
||||
error::EmptyErrorScopeStack,
|
||||
pipeline::{
|
||||
self, ProgrammableStageDescriptor, RenderPipelineVertexProcessor,
|
||||
@@ -706,7 +706,7 @@ impl Global {
|
||||
device_id: DeviceId,
|
||||
desc: &RenderBundleEncoderDescriptor,
|
||||
id_in: id::RenderBundleEncoderId,
|
||||
) -> Result<(), MissingFeatures> {
|
||||
) {
|
||||
let mut hub = self.hub.borrow_mut();
|
||||
let Hub {
|
||||
render_bundle_encoders,
|
||||
@@ -724,11 +724,9 @@ impl Global {
|
||||
multiview: None,
|
||||
};
|
||||
|
||||
let render_bundle_encoder = device.create_render_bundle_encoder(&desc)?;
|
||||
let render_bundle_encoder = device.create_render_bundle_encoder(&desc);
|
||||
|
||||
render_bundle_encoders.assign(id_in, *render_bundle_encoder);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn render_bundle_encoder_finish(
|
||||
|
||||
@@ -423,7 +423,8 @@ impl Device {
|
||||
pub(crate) fn raw(&self) -> &dyn hal::DynDevice {
|
||||
self.raw.as_ref()
|
||||
}
|
||||
pub(crate) fn require_features(&self, feature: wgt::Features) -> Result<(), MissingFeatures> {
|
||||
|
||||
pub fn require_features(&self, feature: wgt::Features) -> Result<(), MissingFeatures> {
|
||||
if self.features.contains(feature) {
|
||||
Ok(())
|
||||
} else {
|
||||
@@ -2864,22 +2865,19 @@ impl Device {
|
||||
pub fn create_render_bundle_encoder(
|
||||
self: &Arc<Self>,
|
||||
desc: &command::RenderBundleEncoderDescriptor,
|
||||
) -> Result<Box<command::RenderBundleEncoder>, MissingFeatures> {
|
||||
) -> Box<command::RenderBundleEncoder> {
|
||||
profiling::scope!("Device::create_render_bundle_encoder");
|
||||
api_log!("Device::create_render_bundle_encoder");
|
||||
command::RenderBundleEncoder::new(self, desc)
|
||||
.or_else(|err| match err {
|
||||
command::CreateRenderBundleError::MissingFeatures(missing) => Err(missing),
|
||||
err => {
|
||||
self.handle_error(
|
||||
err,
|
||||
desc.label.as_ref().map(|l| l.as_ref()),
|
||||
"Device::create_render_bundle_encoder",
|
||||
);
|
||||
Ok(command::RenderBundleEncoder::dummy(self))
|
||||
}
|
||||
})
|
||||
.map(Box::new)
|
||||
Box::new(
|
||||
command::RenderBundleEncoder::new(self, desc).unwrap_or_else(|err| {
|
||||
self.handle_error(
|
||||
err,
|
||||
desc.label.as_deref(),
|
||||
"Device::create_render_bundle_encoder",
|
||||
);
|
||||
command::RenderBundleEncoder::dummy(self)
|
||||
}),
|
||||
)
|
||||
}
|
||||
|
||||
/// Generate information about late-validated buffer bindings for pipelines.
|
||||
|
||||
@@ -228,12 +228,12 @@ impl Device {
|
||||
pub fn create_render_bundle_encoder<'a>(
|
||||
&self,
|
||||
desc: &RenderBundleEncoderDescriptor<'_>,
|
||||
) -> Result<RenderBundleEncoder<'a>, CreateRenderBundleEncoderError> {
|
||||
let encoder = self.inner.create_render_bundle_encoder(desc)?;
|
||||
Ok(RenderBundleEncoder {
|
||||
) -> RenderBundleEncoder<'a> {
|
||||
let encoder = self.inner.create_render_bundle_encoder(desc);
|
||||
RenderBundleEncoder {
|
||||
inner: encoder,
|
||||
_p: PhantomData,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a new [`BindGroup`].
|
||||
|
||||
@@ -1,30 +1,8 @@
|
||||
use alloc::string::String;
|
||||
use core::error::Error;
|
||||
use core::fmt::Display;
|
||||
use core::{marker::PhantomData, num::NonZeroU32, ops::Range};
|
||||
|
||||
use crate::dispatch::RenderBundleEncoderInterface;
|
||||
use crate::*;
|
||||
|
||||
/// Error type for [`Device::create_render_bundle_encoder`].
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
|
||||
pub struct CreateRenderBundleEncoderError(String);
|
||||
|
||||
impl CreateRenderBundleEncoderError {
|
||||
/// Creates a new `CreateRenderBundleEncoderError` with the given message.
|
||||
pub fn new(msg: String) -> Self {
|
||||
Self(msg)
|
||||
}
|
||||
}
|
||||
|
||||
impl Display for CreateRenderBundleEncoderError {
|
||||
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
|
||||
write!(f, "Error while creating render bundle encoder: {}", self.0)
|
||||
}
|
||||
}
|
||||
|
||||
impl Error for CreateRenderBundleEncoderError {}
|
||||
|
||||
/// Encodes a series of GPU operations into a reusable "render bundle".
|
||||
///
|
||||
/// It only supports a handful of render commands, but it makes them reusable.
|
||||
|
||||
@@ -2691,7 +2691,7 @@ impl dispatch::DeviceInterface for WebDevice {
|
||||
fn create_render_bundle_encoder(
|
||||
&self,
|
||||
desc: &crate::RenderBundleEncoderDescriptor<'_>,
|
||||
) -> Result<dispatch::DispatchRenderBundleEncoder, crate::CreateRenderBundleEncoderError> {
|
||||
) -> dispatch::DispatchRenderBundleEncoder {
|
||||
let mapped_color_formats = desc
|
||||
.color_formats
|
||||
.iter()
|
||||
@@ -2718,16 +2718,13 @@ impl dispatch::DeviceInterface for WebDevice {
|
||||
let render_bundle_encoder = self
|
||||
.inner
|
||||
.create_render_bundle_encoder(&mapped_desc)
|
||||
.map_err(|e| {
|
||||
let e = e.dyn_ref::<js_sys::Error>().expect("Expected a JS Error");
|
||||
crate::CreateRenderBundleEncoderError::new(e.message().as_string().unwrap())
|
||||
})?;
|
||||
.unwrap();
|
||||
|
||||
Ok(WebRenderBundleEncoder {
|
||||
WebRenderBundleEncoder {
|
||||
inner: render_bundle_encoder,
|
||||
ident: crate::cmp::Identifier::create(),
|
||||
}
|
||||
.into())
|
||||
.into()
|
||||
}
|
||||
|
||||
fn set_device_lost_callback(&self, device_lost_callback: dispatch::BoxDeviceLostCallback) {
|
||||
|
||||
@@ -1511,7 +1511,7 @@ impl dispatch::DeviceInterface for CoreDevice {
|
||||
fn create_render_bundle_encoder(
|
||||
&self,
|
||||
desc: &crate::RenderBundleEncoderDescriptor<'_>,
|
||||
) -> Result<dispatch::DispatchRenderBundleEncoder, crate::CreateRenderBundleEncoderError> {
|
||||
) -> dispatch::DispatchRenderBundleEncoder {
|
||||
let descriptor = wgc::command::RenderBundleEncoderDescriptor {
|
||||
label: desc.label.map(Borrowed),
|
||||
color_formats: Borrowed(desc.color_formats),
|
||||
@@ -1519,12 +1519,9 @@ impl dispatch::DeviceInterface for CoreDevice {
|
||||
sample_count: desc.sample_count,
|
||||
multiview: desc.multiview,
|
||||
};
|
||||
let encoder = self
|
||||
.wgpu_device
|
||||
.create_render_bundle_encoder(&descriptor)
|
||||
.map_err(|e| crate::CreateRenderBundleEncoderError::new(e.to_string()))?;
|
||||
let encoder = self.wgpu_device.create_render_bundle_encoder(&descriptor);
|
||||
|
||||
Ok(CoreRenderBundleEncoder { encoder }.into())
|
||||
CoreRenderBundleEncoder { encoder }.into()
|
||||
}
|
||||
|
||||
fn set_device_lost_callback(&self, device_lost_callback: dispatch::BoxDeviceLostCallback) {
|
||||
|
||||
@@ -202,7 +202,7 @@ pub trait DeviceInterface: CommonTraits {
|
||||
fn create_render_bundle_encoder(
|
||||
&self,
|
||||
desc: &crate::RenderBundleEncoderDescriptor<'_>,
|
||||
) -> Result<DispatchRenderBundleEncoder, crate::CreateRenderBundleEncoderError>;
|
||||
) -> DispatchRenderBundleEncoder;
|
||||
|
||||
fn set_device_lost_callback(&self, device_lost_callback: BoxDeviceLostCallback);
|
||||
|
||||
|
||||
Reference in new issue
Block a user