awsm-renderer 0.4.1

//! Renderer error types and results.

use awsm_renderer_core::{error::AwsmCoreError, pipeline::primitive::CullMode};
use thiserror::Error;

use crate::{
    bind_group_layout::AwsmBindGroupLayoutError,
    bind_groups::AwsmBindGroupError,
    camera::AwsmCameraError,
    instances::AwsmInstanceError,
    lights::AwsmLightError,
    materials::AwsmMaterialError,
    meshes::{error::AwsmMeshError, skins::AwsmSkinError},
    pipeline_layouts::AwsmPipelineLayoutError,
    pipelines::{
        compute_pipeline::AwsmComputePipelineError, render_pipeline::AwsmRenderPipelineError,
    },
    render_textures::AwsmRenderTextureError,
    shaders::AwsmShaderError,
    shadows::AwsmShadowError,
    textures::AwsmTextureError,
    transforms::AwsmTransformError,
};

/// Errors returned by the renderer crate.
#[derive(Error, Debug)]
pub enum AwsmError {
    #[error("{0}")]
    Core(#[from] AwsmCoreError),

    #[error("{0}")]
    Camera(#[from] AwsmCameraError),

    #[error("{0}")]
    Mesh(#[from] AwsmMeshError),

    #[error("{0}")]
    Transform(#[from] AwsmTransformError),

    #[cfg(feature = "animation")]
    #[error("{0}")]
    Animation(#[from] crate::animation::AwsmAnimationError),

    #[error("{0}")]
    Skin(#[from] AwsmSkinError),

    #[error("{0}")]
    BindGroup(#[from] AwsmBindGroupError),

    #[error("{0}")]
    BindGroupLayout(#[from] AwsmBindGroupLayoutError),

    #[error("{0}")]
    Shader(#[from] AwsmShaderError),

    #[error("{0}")]
    Instance(#[from] AwsmInstanceError),

    #[error("{0}")]
    Material(#[from] AwsmMaterialError),

    #[error("{0}")]
    PipelineLayout(#[from] AwsmPipelineLayoutError),

    #[error("{0}")]
    RenderPipeline(#[from] AwsmRenderPipelineError),

    #[error("{0}")]
    ComputePipeline(#[from] AwsmComputePipelineError),

    #[error("{0}")]
    Light(#[from] AwsmLightError),

    #[error("{0}")]
    RenderTexture(#[from] AwsmRenderTextureError),

    #[error("Unregistered Msaa count: {0}")]
    UnsupportedMsaaCount(u32),

    #[error("Unregistered Cull Mode: {0:?}")]
    UnsupportedCullMode(CullMode),

    /// A render-frame dispatch site found that a pipeline variant
    /// hasn't been compiled yet (pipeline group still `Pending`, or
    /// `Failed` and skipped). Used by the warn-and-skip safety net in
    /// the render-frame preamble; never raised from synchronous code
    /// paths.
    #[error("Pipeline variant not yet compiled: {0}")]
    PipelineVariantNotCompiled(&'static str),

    /// A dynamic / custom material's shader failed to compile. Carries the
    /// real WGSL compile diagnostic (line/column + message, pulled from the
    /// shader module's `getCompilationInfo`) when one is available, falling
    /// back to the raw `createComputePipelineAsync` rejection text otherwise.
    /// Surfaces to authors via [`crate::AwsmRenderer::dynamic_material_compile_status`].
    #[error("Material shader compile failed:\n{0}")]
    MaterialShaderCompile(String),

    /// A config-change API (e.g. `set_anti_aliasing`,
    /// `set_post_processing`) was called before `AwsmRendererBuilder::build`
    /// finished its eager-set compile batch. The first valid call site
    /// is post-`.await` of the build.
    #[error("Renderer not ready (config-change API called before build completed)")]
    NotReady,

    #[error("{0}")]
    Texture(#[from] AwsmTextureError),

    #[error("{0}")]
    OpaqueMipgen(#[from] crate::opaque_mipgen::AwsmOpaqueMipgenError),

    #[error("{0}")]
    Shadow(#[from] AwsmShadowError),

    #[error("{0}")]
    FrameGlobals(#[from] crate::frame_globals::AwsmFrameGlobalsError),

    #[error("{0}")]
    DynamicMaterial(#[from] crate::dynamic_materials::AwsmDynamicMaterialError),
}

/// Renderer result type.
pub type Result<T> = std::result::Result<T, AwsmError>;