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

//! Utilities for loading global textures from the `monolib/shader` folder or calculated in previous passes.
//!
//! # Supported Global Textures
//! | Sampler | monolib/shader Texture |
//! | --- | --- |
//! | gTResidentTex01 | kokuin_mska.witex |
//! | gTResidentTex02 | kokuin_mskb.witex |
//! | gTResidentTex03 | a_armor_env.witex |
//! | gTResidentTex04 | dirt_col.witex |
//! | gTResidentTex05 | dirt_mask.witex |
//! | gTResidentTex06 | dirtskin_col.witex |
//! | gTResidentTex07 | dirtskin_mask.witex |
//! | gTResidentTex08 | hat_a_ptmsk.witex |
//! | gTResidentTex09 | hatching_a_ptnrm.witex |
//! | gTResidentTex11 | k_metal_env.witex |
//! | gTResidentTex12 | k_visor_env.witex |
//! | gTResidentTex15 | mobeye_female_col.witex |
//! | gTResidentTex16 | mobeye_female_mask.witex |
//! | gTResidentTex17 | mobeye_male_col.witex |
//! | gTResidentTex18 | mobeye_male_mask.witex |
//! | gTResidentTex19 | mobhair_col.witex |
//! | gTResidentTex20 | firedial_a_amb.witex |
//! | gTResidentTex21 | firedial_a_col.witex |
//! | gTResidentTex22 | firedial_a_mtl.witex |
//! | gTResidentTex23 | firedial_a_nrm.witex |
//! | gTResidentTex24 | firedial_a_shy.witex |
//! | gTResidentTex25 | firedial_b_amb.witex |
//! | gTResidentTex26 | firedial_b_col.witex |
//! | gTResidentTex27 | firedial_b_mtl.witex |
//! | gTResidentTex28 | firedial_b_nrm.witex |
//! | gTResidentTex29 | firedial_b_shy.witex |
//! | gTResidentTex30 | firedial_c_amb.witex |
//! | gTResidentTex31 | firedial_c_col.witex |
//! | gTResidentTex32 | firedial_c_mtl.witex |
//! | gTResidentTex33 | firedial_c_nrm.witex |
//! | gTResidentTex43 | eyepatch_ao.witex |
//! | gTResidentTex44 | eyepatch_col.witex |
//! | gTResidentTex45 | eyepatch_mask.witex |
//! | gTResidentTex46 | eyepatch_nrm.witex |
//! | gTToonGrad | toon_grad.witex |
//! | gTToonDarkGrad | toon_grad_night.witex |
use crate::ImageTexture;
use std::{collections::BTreeMap, path::Path};
use xc3_lib::mibl::Mibl;

/// Textures and resources from the `monolib/shader` folder or calculated in previous passes.
#[derive(Debug, PartialEq, Clone, Default)]
pub struct ShaderTextures {
    /// The texture like `toon_grad.witex` for supported sampler names like `gTToonGrad`.
    /// Missing files will be set to `None`.
    pub textures: BTreeMap<&'static str, Option<ImageTexture>>,
}

impl ShaderTextures {
    pub fn from_folder<P: AsRef<Path>>(path: P) -> Self {
        // TODO: Are the name mappings the same for all 3 games?
        let path = path.as_ref();
        Self {
            textures: [
                ("gTResidentTex01", tex(path, "kokuin_mska.witex")),
                ("gTResidentTex02", tex(path, "kokuin_mskb.witex")),
                ("gTResidentTex03", tex(path, "a_armor_env.witex")),
                ("gTResidentTex04", tex(path, "dirt_col.witex")),
                ("gTResidentTex05", tex(path, "dirt_mask.witex")),
                ("gTResidentTex06", tex(path, "dirtskin_col.witex")),
                ("gTResidentTex07", tex(path, "dirtskin_mask.witex")),
                ("gTResidentTex08", tex(path, "hat_a_ptmsk.witex")),
                ("gTResidentTex09", tex(path, "hatching_a_ptnrm.witex")),
                ("gTResidentTex11", tex(path, "k_metal_env.witex")),
                ("gTResidentTex12", tex(path, "k_visor_env.witex")),
                ("gTResidentTex15", tex(path, "mobeye_female_col.witex")),
                ("gTResidentTex16", tex(path, "mobeye_female_mask.witex")),
                ("gTResidentTex17", tex(path, "mobeye_male_col.witex")),
                ("gTResidentTex18", tex(path, "mobeye_male_mask.witex")),
                ("gTResidentTex19", tex(path, "mobhair_col.witex")),
                ("gTResidentTex20", tex(path, "firedial_a_amb.witex")),
                ("gTResidentTex21", tex(path, "firedial_a_col.witex")),
                ("gTResidentTex22", tex(path, "firedial_a_mtl.witex")),
                ("gTResidentTex23", tex(path, "firedial_a_nrm.witex")),
                ("gTResidentTex24", tex(path, "firedial_a_shy.witex")),
                ("gTResidentTex25", tex(path, "firedial_b_amb.witex")),
                ("gTResidentTex26", tex(path, "firedial_b_col.witex")),
                ("gTResidentTex27", tex(path, "firedial_b_mtl.witex")),
                ("gTResidentTex28", tex(path, "firedial_b_nrm.witex")),
                ("gTResidentTex29", tex(path, "firedial_b_shy.witex")),
                ("gTResidentTex30", tex(path, "firedial_c_amb.witex")),
                ("gTResidentTex31", tex(path, "firedial_c_col.witex")),
                ("gTResidentTex32", tex(path, "firedial_c_mtl.witex")),
                ("gTResidentTex33", tex(path, "firedial_c_nrm.witex")),
                ("gTResidentTex43", tex(path, "eyepatch_ao.witex")),
                ("gTResidentTex44", tex(path, "eyepatch_col.witex")),
                ("gTResidentTex45", tex(path, "eyepatch_mask.witex")),
                ("gTResidentTex46", tex(path, "eyepatch_nrm.witex")),
                ("gTAmbBRDF", tex(path, "ambientbrdf.witex")),
                ("gTToonGrad", tex(path, "toon_grad.witex")),
                ("gTToonDarkGrad", tex(path, "toon_grad_night.witex")),
                // Defaults for global textures not in monolib/shader
                ("gTLightShaft", default_texture("gTLightShaft", [0; 4])),
                ("texAO", default_texture("texAO", [128; 4])),
                ("texShadow", default_texture("texShadow", [255; 4])),
                ("texLgt", default_texture("texLgt", [0; 4])),
                ("texRef", default_texture("texRef", [255; 4])),
                ("gIBL", default_texture("gIBL", [255, 255, 255, 0])),
            ]
            .into(),
        }
    }

    // TODO: Load defaults if texture is missing?
    /// Find the texture corresponding to a `sampler_name` like `gTResidentTex44`.
    pub fn global_texture(&self, sampler_name: &str) -> Option<&ImageTexture> {
        self.textures.get(sampler_name)?.as_ref()
    }
}

fn tex(path: &Path, name: &str) -> Option<ImageTexture> {
    let mibl = Mibl::from_file(path.join(name)).ok()?;
    Some(ImageTexture::from_mibl(&mibl, Some(name.to_string()), None).unwrap())
}

fn default_texture(name: &str, rgba: [u8; 4]) -> Option<ImageTexture> {
    Some(ImageTexture {
        name: Some(name.to_string()),
        usage: None,
        width: 4,
        height: 4,
        depth: 1,
        view_dimension: xc3_lib::mibl::ViewDimension::D2,
        image_format: xc3_lib::mibl::ImageFormat::R8G8B8A8Unorm,
        mipmap_count: 1,
        image_data: std::iter::repeat_n(rgba, 16).flatten().collect(),
    })
}