Struct bevy_render::renderer::ErasedRenderDevice
source · pub struct ErasedRenderDevice(/* private fields */);
Implementations§
Methods from Deref<Target = Device>§
sourcepub fn poll(&self, maintain: Maintain<SubmissionIndex>) -> MaintainResult
pub fn poll(&self, maintain: Maintain<SubmissionIndex>) -> MaintainResult
Check for resource cleanups and mapping callbacks. Will block if Maintain::Wait
is passed.
Return true
if the queue is empty, or false
if there are more queue
submissions still in flight. (Note that, unless access to the Queue
is
coordinated somehow, this information could be out of date by the time
the caller receives it. Queue
s can be shared between threads, so
other threads could submit new work at any time.)
When running on WebGPU, this is a no-op. Device
s are automatically polled.
sourcepub fn features(&self) -> Features
pub fn features(&self) -> Features
The features which can be used on this device.
No additional features can be used, even if the underlying adapter can support them.
sourcepub fn limits(&self) -> Limits
pub fn limits(&self) -> Limits
The limits which can be used on this device.
No better limits can be used, even if the underlying adapter can support them.
sourcepub fn create_shader_module(
&self,
desc: ShaderModuleDescriptor<'_>
) -> ShaderModule
pub fn create_shader_module( &self, desc: ShaderModuleDescriptor<'_> ) -> ShaderModule
Creates a shader module from either SPIR-V or WGSL source code.
This function may consume a lot of stack space. Compiler-enforced limits for parsing recursion exist; if shader compilation runs into them, it will return an error gracefully. However, on some build profiles and platforms, the default stack size for a thread may be exceeded before this limit is reached during parsing. Callers should ensure that there is enough stack space for this, particularly if calls to this method are exposed to user input.
sourcepub unsafe fn create_shader_module_unchecked(
&self,
desc: ShaderModuleDescriptor<'_>
) -> ShaderModule
pub unsafe fn create_shader_module_unchecked( &self, desc: ShaderModuleDescriptor<'_> ) -> ShaderModule
Creates a shader module from either SPIR-V or WGSL source code without runtime checks.
§Safety
In contrast with create_shader_module
this function
creates a shader module without runtime checks which allows shaders to perform
operations which can lead to undefined behavior like indexing out of bounds, thus it’s
the caller responsibility to pass a shader which doesn’t perform any of this
operations.
This has no effect on web.
sourcepub unsafe fn create_shader_module_spirv(
&self,
desc: &ShaderModuleDescriptorSpirV<'_>
) -> ShaderModule
pub unsafe fn create_shader_module_spirv( &self, desc: &ShaderModuleDescriptorSpirV<'_> ) -> ShaderModule
Creates a shader module from SPIR-V binary directly.
§Safety
This function passes binary data to the backend as-is and can potentially result in a driver crash or bogus behaviour. No attempt is made to ensure that data is valid SPIR-V.
See also include_spirv_raw!
and util::make_spirv_raw
.
sourcepub fn create_command_encoder(
&self,
desc: &CommandEncoderDescriptor<Option<&str>>
) -> CommandEncoder
pub fn create_command_encoder( &self, desc: &CommandEncoderDescriptor<Option<&str>> ) -> CommandEncoder
Creates an empty CommandEncoder
.
sourcepub fn create_render_bundle_encoder(
&self,
desc: &RenderBundleEncoderDescriptor<'_>
) -> RenderBundleEncoder<'_>
pub fn create_render_bundle_encoder( &self, desc: &RenderBundleEncoderDescriptor<'_> ) -> RenderBundleEncoder<'_>
Creates an empty RenderBundleEncoder
.
sourcepub fn create_bind_group(&self, desc: &BindGroupDescriptor<'_>) -> BindGroup
pub fn create_bind_group(&self, desc: &BindGroupDescriptor<'_>) -> BindGroup
Creates a new BindGroup
.
sourcepub fn create_bind_group_layout(
&self,
desc: &BindGroupLayoutDescriptor<'_>
) -> BindGroupLayout
pub fn create_bind_group_layout( &self, desc: &BindGroupLayoutDescriptor<'_> ) -> BindGroupLayout
Creates a BindGroupLayout
.
sourcepub fn create_pipeline_layout(
&self,
desc: &PipelineLayoutDescriptor<'_>
) -> PipelineLayout
pub fn create_pipeline_layout( &self, desc: &PipelineLayoutDescriptor<'_> ) -> PipelineLayout
Creates a PipelineLayout
.
sourcepub fn create_render_pipeline(
&self,
desc: &RenderPipelineDescriptor<'_>
) -> RenderPipeline
pub fn create_render_pipeline( &self, desc: &RenderPipelineDescriptor<'_> ) -> RenderPipeline
Creates a RenderPipeline
.
sourcepub fn create_compute_pipeline(
&self,
desc: &ComputePipelineDescriptor<'_>
) -> ComputePipeline
pub fn create_compute_pipeline( &self, desc: &ComputePipelineDescriptor<'_> ) -> ComputePipeline
Creates a ComputePipeline
.
sourcepub fn create_buffer(&self, desc: &BufferDescriptor<Option<&str>>) -> Buffer
pub fn create_buffer(&self, desc: &BufferDescriptor<Option<&str>>) -> Buffer
Creates a Buffer
.
sourcepub fn create_texture(
&self,
desc: &TextureDescriptor<Option<&str>, &[TextureFormat]>
) -> Texture
pub fn create_texture( &self, desc: &TextureDescriptor<Option<&str>, &[TextureFormat]> ) -> Texture
Creates a new Texture
.
desc
specifies the general format of the texture.
sourcepub unsafe fn create_texture_from_hal<A>(
&self,
hal_texture: <A as Api>::Texture,
desc: &TextureDescriptor<Option<&str>, &[TextureFormat]>
) -> Texturewhere
A: HalApi,
pub unsafe fn create_texture_from_hal<A>(
&self,
hal_texture: <A as Api>::Texture,
desc: &TextureDescriptor<Option<&str>, &[TextureFormat]>
) -> Texturewhere
A: HalApi,
sourcepub unsafe fn create_buffer_from_hal<A>(
&self,
hal_buffer: <A as Api>::Buffer,
desc: &BufferDescriptor<Option<&str>>
) -> Bufferwhere
A: HalApi,
pub unsafe fn create_buffer_from_hal<A>(
&self,
hal_buffer: <A as Api>::Buffer,
desc: &BufferDescriptor<Option<&str>>
) -> Bufferwhere
A: HalApi,
sourcepub fn create_sampler(&self, desc: &SamplerDescriptor<'_>) -> Sampler
pub fn create_sampler(&self, desc: &SamplerDescriptor<'_>) -> Sampler
Creates a new Sampler
.
desc
specifies the behavior of the sampler.
sourcepub fn create_query_set(
&self,
desc: &QuerySetDescriptor<Option<&str>>
) -> QuerySet
pub fn create_query_set( &self, desc: &QuerySetDescriptor<Option<&str>> ) -> QuerySet
Creates a new QuerySet
.
sourcepub fn on_uncaptured_error(
&self,
handler: Box<dyn UncapturedErrorHandler<Output = ()>>
)
pub fn on_uncaptured_error( &self, handler: Box<dyn UncapturedErrorHandler<Output = ()>> )
Set a callback for errors that are not handled in error scopes.
sourcepub fn push_error_scope(&self, filter: ErrorFilter)
pub fn push_error_scope(&self, filter: ErrorFilter)
Push an error scope.
sourcepub fn pop_error_scope(
&self
) -> impl Future<Output = Option<Error>> + WasmNotSend
pub fn pop_error_scope( &self ) -> impl Future<Output = Option<Error>> + WasmNotSend
Pop an error scope.
sourcepub fn start_capture(&self)
pub fn start_capture(&self)
Starts frame capture.
sourcepub fn stop_capture(&self)
pub fn stop_capture(&self)
Stops frame capture.
sourcepub unsafe fn as_hal<A, F, R>(&self, hal_device_callback: F) -> Option<R>
pub unsafe fn as_hal<A, F, R>(&self, hal_device_callback: F) -> Option<R>
Apply a callback to this Device
’s underlying backend device.
If this Device
is implemented by the backend API given by A
(Vulkan,
Dx12, etc.), then apply hal_device_callback
to Some(&device)
, where
device
is the underlying backend device type, A::Device
.
If this Device
uses a different backend, apply hal_device_callback
to None
.
The device is locked for reading while hal_device_callback
runs. If
the callback attempts to perform any wgpu
operations that require
write access to the device (destroying a buffer, say), deadlock will
occur. The locks are automatically released when the callback returns.
§Safety
- The raw handle passed to the callback must not be manually destroyed.
sourcepub fn set_device_lost_callback(
&self,
callback: impl Fn(DeviceLostReason, String) + Send + 'static
)
pub fn set_device_lost_callback( &self, callback: impl Fn(DeviceLostReason, String) + Send + 'static )
Set a DeviceLostCallback on this device.
Trait Implementations§
source§impl Clone for ErasedRenderDevice
impl Clone for ErasedRenderDevice
source§impl Debug for ErasedRenderDevice
impl Debug for ErasedRenderDevice
source§impl Deref for ErasedRenderDevice
impl Deref for ErasedRenderDevice
source§impl Drop for ErasedRenderDevice
impl Drop for ErasedRenderDevice
impl Send for ErasedRenderDevice
impl Sync for ErasedRenderDevice
Auto Trait Implementations§
impl Freeze for ErasedRenderDevice
impl RefUnwindSafe for ErasedRenderDevice
impl Unpin for ErasedRenderDevice
impl UnwindSafe for ErasedRenderDevice
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.