Enum RenderError 

#[non_exhaustive]
pub enum RenderError {
    ZeroDimension,
    DimensionTooLarge,
    InvalidColor,
    InvalidVisual,
    InvalidEffectParameter,
    UnknownEffect,
    InvalidEffectParams,
    InvalidEffectResource,
    MissingEffectResource,
    EffectResourceKindMismatch,
    MissingEffectInput,
    MissingText,
    InvalidImageData,
    TextureReadback(ReadbackFailure),
    InvalidGraph,
    ExternalTextureSync(Option<GpuFault>),
    InvalidPlaneTarget,
    GpuTimeout,
    GpuWorkDropped,
    Gpu {
        kind: GpuErrorKind,
    },
    GpuDeviceLost,
    GpuDeviceHung {
        frame: Option<u64>,
        time_ticks: Option<i64>,
        gpu_ms: u32,
        watchdog_ms: u32,
    },
    UnsupportedHdr,
    InvalidSource,
}

Render input or output failure.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ZeroDimension

Render targets must have non-zero dimensions.

DimensionTooLarge

Render dimensions exceed the configured or physical device limit.

InvalidColor

Colors must be finite, in the unit interval, and premultiplied.

InvalidVisual

A layer transform is non-finite, has zero scale, or invalid opacity.

InvalidEffectParameter

An effect parameter is non-finite or outside its supported range.

UnknownEffect

No effect with the requested identity is registered.

InvalidEffectParams

Supplied parameter names or types do not match the effect schema.

InvalidEffectResource

An uploaded effect resource has an invalid identity, shape, or payload.

MissingEffectResource

An effect invocation omitted a required registered resource.

EffectResourceKindMismatch

A resource identity resolves to a different representation than required.

MissingEffectInput

A transition invocation omitted its second texture.

MissingText

A frame needs a caption, text generator or layout its host did not prepare at this size.

InvalidImageData

RGBA input byte length does not match the declared image size.

TextureReadback(ReadbackFailure)

A rendered texture could not be read back to host memory, and where.

InvalidGraph

An internally constructed render graph was structurally invalid.

ExternalTextureSync(Option<GpuFault>)

A native texture could not synchronize with the submission, with the platform’s device status when available.

InvalidPlaneTarget

Caller NV12 planes are not R8 luma and RG8 chroma render attachments at full and half size.

GpuTimeout

GPU work did not complete within the renderer’s wait timeout.

GpuWorkDropped

The device completed a submission without running it (a readback lacked its canary). The renderer refuses further work; only a new process gets a working device.

Gpu

The GPU rejected this frame’s work (failed allocation or invalid use). Nothing ran, the device is fine, and the renderer kept nothing of the frame.

Fields

kind: GpuErrorKind

The class of error the GPU reported.

GpuDeviceLost

The device can no longer create the resources a frame needs; the renderer refuses further work.

GpuDeviceHung

The device was lost after a recent submission kept the GPU busy for at least half the OS watchdog (alpha2_gpu::hung_threshold_ms). Rerunning the same work will hang again.

Fields

frame: Option<u64>

The export frame the long submission rendered, when known.

time_ticks: Option<i64>

That frame’s timeline time, in ticks, when known.

gpu_ms: u32

How long the submission kept the GPU busy, in milliseconds.

watchdog_ms: u32

The watchdog it was measured against, in milliseconds.

UnsupportedHdr

An HDR (PQ or HLG) source met crate::ColorPolicy::RejectHdr.

InvalidSource

A source belongs to the other backend (CPU source on GPU renderer or vice versa).

Trait Implementations

impl Clone for RenderError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for RenderError

impl Debug for RenderError

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

Formats the value using the given formatter.

impl Display for RenderError

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

Formats the value using the given formatter.

impl Eq for RenderError

impl Error for RenderError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl From<RenderError> for GraphError

fn from(error: RenderError) -> Self

Converts to this type from the input type.

impl PartialEq for RenderError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RenderError