1
Fork 0
mirror of https://github.com/redstrate/Physis.git synced 2025-04-24 21:37:46 +00:00

Improve SHPK documentation

This commit is contained in:
Joshua Goins 2023-12-02 19:58:22 -05:00
parent a2db761e18
commit 88562f4dc6

View file

@ -78,15 +78,19 @@ struct SHPKHeader {
} }
pub struct Shader { pub struct Shader {
/// The HLSL bytecode of this shader. The DX level used varies.
pub bytecode: Vec<u8> pub bytecode: Vec<u8>
} }
pub struct ShaderPackage { pub struct ShaderPackage {
/// The vertex shaders in this package
pub vertex_shaders: Vec<Shader>, pub vertex_shaders: Vec<Shader>,
/// The pixel (fragment) shaders in this package
pub pixel_shaders: Vec<Shader> pub pixel_shaders: Vec<Shader>
} }
impl ShaderPackage { impl ShaderPackage {
/// Reads an existing SHPK file
pub fn from_existing(buffer: ByteSpan) -> Option<ShaderPackage> { pub fn from_existing(buffer: ByteSpan) -> Option<ShaderPackage> {
let mut cursor = Cursor::new(buffer); let mut cursor = Cursor::new(buffer);
let shpk_header = SHPKHeader::read(&mut cursor).unwrap(); let shpk_header = SHPKHeader::read(&mut cursor).unwrap();