physis 0.6.0

Library for reading and writing FFXIV data.
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

// SPDX-FileCopyrightText: 2024 Joshua Goins <josh@redstrate.com>
// SPDX-License-Identifier: GPL-3.0-or-later

use std::io::Cursor;
use std::io::SeekFrom;

use crate::ByteSpan;
use crate::ReadableFile;
use crate::common::Platform;
use binrw::BinRead;
use binrw::binread;

/// Graphics pipeline shader stage.
#[binread]
#[derive(Debug, Clone, Copy)]
#[repr(C)]
pub enum ShaderStage {
    /// Vertex stage.
    #[br(magic = 0u8)]
    Vertex,
    /// Pixel/fragment stage.
    #[br(magic = 1u8)]
    Pixel,
}

/// Shader file, usually with the `.shcd` file extension.
///
/// Used instead of a shader package for standalone shaders.
#[binread]
#[derive(Debug)]
#[brw(magic = b"ShCd")]
#[allow(dead_code)]
pub struct SHCD {
    version: i32,

    /// "DX9\0" or "DX11".
    #[br(count = 4)]
    #[bw(pad_size_to = 4)]
    #[bw(map = |x : &String | x.as_bytes())]
    #[br(map = | x: Vec<u8> | String::from_utf8(x).unwrap().trim_matches(char::from(0)).to_string())]
    pub format: String,

    file_length: u32,
    shader_offset: u32,
    parameter_offset: u32,
    /// The stage this shader runs in.
    #[brw(pad_size_to = 4)]
    pub stage: ShaderStage,
    shader_data_length: u32,

    // TODO: there's other interesting data in here
    // TODO: read parameters
    /// DXBC bytecode.
    #[br(seek_before = SeekFrom::Start(shader_offset as u64))]
    #[br(count = shader_data_length)]
    #[br(restore_position)]
    pub bytecode: Vec<u8>,
}

impl ReadableFile for SHCD {
    fn from_existing(platform: Platform, buffer: ByteSpan) -> Option<Self> {
        let mut cursor = Cursor::new(buffer);
        SHCD::read_options(&mut cursor, platform.endianness(), ()).ok()
    }
}

#[cfg(test)]
mod tests {
    use crate::pass_random_invalid;

    use super::*;

    #[test]
    fn test_invalid() {
        pass_random_invalid::<SHCD>();
    }
}