xc3_model 0.21.0

High level library for xc3_lib
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

use thiserror::Error;
use xc3_lib::error::{DecompressStreamError, ExtractStreamFilesError, ReadFileError};

#[derive(Debug, Error)]
pub enum LoadModelError {
    #[error("error reading wimdo file")]
    Wimdo(#[source] ReadFileError),

    #[error("error extracting texture from wimdo file")]
    WimdoPackedTexture {
        #[source]
        source: binrw::Error,
    },

    #[error("error reading vertex data")]
    VertexData(binrw::Error),

    #[error("failed to find Mxmd in Apmd file")]
    MissingApmdMxmdEntry,

    #[error("expected packed wimdo vertex data but found none")]
    MissingMxmdVertexData,

    #[error("expected packed wimdo shader data but found none")]
    MissingMxmdShaderData,

    #[error("error loading image texture")]
    Image(#[from] CreateImageTextureError),

    #[error("error decompressing stream")]
    Stream(#[from] DecompressStreamError),

    #[error("error extracting stream data")]
    ExtractFiles(#[from] ExtractStreamFilesError),

    #[error("error reading legacy wismt streaming file")]
    WismtLegacy(#[source] ReadFileError),

    #[error("error reading wismt streaming file")]
    Wismt(#[source] ReadFileError),
}

#[derive(Debug, Error)]
pub enum LoadModelLegacyError {
    #[error("error reading camdo file")]
    Camdo(#[source] ReadFileError),

    #[error("error reading vertex data")]
    VertexData(binrw::Error),

    #[error("error loading image texture")]
    Image(#[from] CreateImageTextureError),

    #[error("error reading casmt streaming file")]
    Casmt(#[source] std::io::Error),
}

#[derive(Debug, Error)]
pub enum CreateModelError {
    #[error("error extracting stream data")]
    ExtractFiles(#[from] ExtractStreamFilesError),

    #[error("creating a version {version} model is not supported")]
    UnsupportedVersion { version: u32 },
}

#[derive(Debug, Error)]
pub enum LoadCollisionsError {
    #[error("error reading idcm streaming file")]
    Idcm(#[from] ReadFileError),
}

// TODO: Add more error variants.
#[cfg(feature = "gltf")]
#[derive(Debug, Error)]
pub enum CreateGltfError {
    #[error("error writing buffers")]
    Binrw(#[from] binrw::Error),
}

#[cfg(feature = "gltf")]
#[derive(Debug, Error)]
pub enum SaveGltfError {
    #[error("error writing files")]
    Io(#[from] std::io::Error),

    #[error("error serializing JSON file")]
    Json(#[from] serde_json::Error),
}

#[derive(Debug, Error)]
pub enum LoadMapError {
    #[error("error reading data")]
    Io(#[from] std::io::Error),

    #[error("error reading wismhd file")]
    Wismhd(#[source] ReadFileError),

    #[error("error reading data")]
    Binrw(#[from] binrw::Error),

    #[error("error loading image texture")]
    Image(#[from] CreateImageTextureError),

    #[error("error decompressing stream")]
    Stream(#[from] DecompressStreamError),
}

#[derive(Debug, Error)]
pub enum LoadShaderDatabaseError {
    #[error("error reading shader file")]
    Io(#[from] binrw::Error),
}

#[derive(Debug, Error)]
pub enum SaveShaderDatabaseError {
    #[error("error writing shader file")]
    Io(#[from] binrw::Error),
}

#[derive(Debug, Error)]
pub enum CreateImageTextureError {
    #[error("error deswizzling surface")]
    SwizzleMibl(#[from] xc3_lib::mibl::SwizzleError),

    #[error("error deswizzling surface")]
    SwizzleMtxt(#[from] xc3_lib::mtxt::SwizzleError),

    #[error("error reading data")]
    Binrw(#[from] binrw::Error),

    #[error("error decompressing stream")]
    Stream(#[from] DecompressStreamError),

    #[error("error converting image surface")]
    Surface(#[from] image_dds::error::SurfaceError),

    #[error("error converting Mibl texture")]
    Mibl(#[from] xc3_lib::error::CreateMiblError),
}