Skip to main content

RenderError

Enum RenderError 

Source
pub enum RenderError {
Show 16 variants AdapterNotFound, DeviceError(String), SurfaceCreation(String), ShaderFileRead { path: String, source: Error, }, GlslParse { name: String, details: String, }, WgslParse { name: String, details: String, }, ShaderValidation { name: String, details: String, }, WgslGeneration { name: String, details: String, }, NoActiveShader(String), ImageLoad { path: String, source: ImageError, }, InvalidTextureData { expected: usize, actual: usize, }, CubemapGeometry(String), CubemapFaceNotFound(String), Surface(SurfaceError), ScreenshotMap(String), ScreenshotImageAssembly,
}
Expand description

Top-level error type for the GPU rendering engine.

Covers the main failure categories that callers may want to distinguish:

  • GPU initialisation (adapter, device, surface)
  • Shader compilation and reload
  • Image / texture loading
  • GPU surface / presentation
  • Screenshot capture

Variants§

§

AdapterNotFound

A suitable wgpu GPU adapter could not be found for the given surface.

§

DeviceError(String)

The wgpu device could not be created or the device was lost.

§

SurfaceCreation(String)

The wgpu surface could not be created for the window.

§

ShaderFileRead

The shader source file could not be read from disk.

Fields

§path: String

Path to the shader file that could not be read.

§source: Error

Underlying I/O error.

§

GlslParse

The GLSL source could not be parsed (transpilation step 1).

Fields

§name: String

Shader name or path.

§details: String

Human-readable parse error messages.

§

WgslParse

The intermediate WGSL source could not be parsed.

Fields

§name: String

Shader name or path.

§details: String

Human-readable parse error details.

§

ShaderValidation

The shader module failed naga validation.

Fields

§name: String

Shader name or path.

§details: String

Human-readable validation error details.

§

WgslGeneration

WGSL generation (from the naga IR) failed.

Fields

§name: String

Shader name or path.

§details: String

Human-readable generation error details.

§

NoActiveShader(String)

A shader reload was requested but no shader is currently active, or a shader compilation error occurred during reload.

§

ImageLoad

An image file could not be opened or decoded.

Fields

§path: String

Path to the image that failed to load.

§source: ImageError

Underlying image error.

§

InvalidTextureData

The supplied raw RGBA byte slice has an unexpected length.

Fields

§expected: usize

Expected byte count (width * height * 4).

§actual: usize

Actual byte count received.

§

CubemapGeometry(String)

A cubemap face image is not square or all faces are not the same size.

§

CubemapFaceNotFound(String)

A required cubemap face file could not be found on disk.

§

Surface(SurfaceError)

Surface::get_current_texture() failed (timeout, outdated, lost, …).

§

ScreenshotMap(String)

The GPU buffer could not be mapped back to CPU memory, or a render step during screenshot capture failed.

§

ScreenshotImageAssembly

The pixel data could not be assembled into a final RgbaImage.

Trait Implementations§

Source§

impl Debug for RenderError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for RenderError

Source§

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for RenderError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<CreateSurfaceError> for RenderError

Source§

fn from(e: CreateSurfaceError) -> Self

Converts to this type from the input type.
Source§

impl From<RequestDeviceError> for RenderError

Source§

fn from(e: RequestDeviceError) -> Self

Converts to this type from the input type.
Source§

impl From<SurfaceError> for RenderError

Source§

fn from(source: SurfaceError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToSmolStr for T
where T: Display + ?Sized,

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,