vrm-spec 0.1.0

VRM data structures
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

//! Data structures for the [`VRMC_materials_mtoon`](https://github.com/vrm-c/vrm-specification/tree/master/specification/VRMC_materials_mtoon-1.0) 1.0 glTF Extension.

use serde::{Deserialize, Serialize};

/// VRMC_materials_mtoon extension name
pub const VRMC_MATERIALS_MTOON: &str = "VRMC_materials_mtoon";

#[cfg(feature = "rustc_hash")]
use rustc_hash::FxHashMap as HashMap;
#[cfg(not(feature = "rustc_hash"))]
use std::collections::HashMap;

#[cfg(feature = "gltf_index")]
use gltf::json::texture::Info as TextureInfo;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct VrmcMaterialsMtoonSchema {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<HashMap<String, HashMap<String, Option<serde_json::Value>>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extras: Option<serde_json::Value>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub gi_equalization_factor: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub matcap_factor: Option<[f64; 3]>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub matcap_texture: Option<TextureInfo>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub outline_color_factor: Option<[f64; 3]>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub outline_lighting_mix_factor: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub outline_width_factor: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub outline_width_mode: Option<OutlineWidthMode>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub outline_width_multiply_texture: Option<TextureInfo>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub parametric_rim_color_factor: Option<[f64; 3]>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub parametric_rim_fresnel_power_factor: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub parametric_rim_lift_factor: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub render_queue_offset_number: Option<i64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub rim_lighting_mix_factor: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub rim_multiply_texture: Option<TextureInfo>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub shade_color_factor: Option<[f64; 3]>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub shade_multiply_texture: Option<TextureInfo>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub shading_shift_factor: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub shading_shift_texture: Option<ShadingShiftTextureInfo>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub shading_toony_factor: Option<f64>,

    /// Specification version of VRMC_materials_mtoon
    pub spec_version: String,

    /// enable depth buffer when `alphaMode` is `BLEND`
    #[serde(skip_serializing_if = "Option::is_none")]
    pub transparent_with_z_write: Option<bool>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub uv_animation_mask_texture: Option<TextureInfo>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub uv_animation_rotation_speed_factor: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub uv_animation_scroll_x_speed_factor: Option<f64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub uv_animation_scroll_y_speed_factor: Option<f64>,
}

/// Reference to a texture.
#[cfg(not(feature = "gltf_index"))]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TextureInfo {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<HashMap<String, HashMap<String, Option<serde_json::Value>>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extras: Option<serde_json::Value>,

    pub index: usize,

    /// The set index of texture's TEXCOORD attribute used for texture coordinate mapping.
    #[cfg(feature = "gltf_index")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tex_coord: Option<gltf::json::Index<gltf::json::Accessor>>,
    #[cfg(not(feature = "gltf_index"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tex_coord: Option<usize>,
}

/// Reference to a texture.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ShadingShiftTextureInfo {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<HashMap<String, HashMap<String, Option<serde_json::Value>>>>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub extras: Option<serde_json::Value>,

    /// The index of the texture.
    #[cfg(feature = "gltf_index")]
    pub index: gltf::json::Index<gltf::json::Texture>,
    #[cfg(not(feature = "gltf_index"))]
    pub index: usize,

    /// The scalar multiplier applied to the texture.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub scale: Option<f64>,

    /// The set index of texture's TEXCOORD attribute used for texture coordinate mapping.
    #[cfg(feature = "gltf_index")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tex_coord: Option<gltf::json::Index<gltf::json::Accessor>>,
    #[cfg(not(feature = "gltf_index"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tex_coord: Option<usize>,
}

/// Outline
#[derive(Debug, Clone, Copy, Hash, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum OutlineWidthMode {
    None,
    ScreenCoordinates,
    WorldCoordinates,
}