Rust渲染插件库shank_render使用指南

完整示例代码

下面是一个整合了基础功能和部分高级功能的完整示例：

use shank_render::{
    Renderer, RenderConfig, 
    Vertex, Transform,
    PostEffectChain, BloomEffect
};

fn main() {
    // 1. 初始化渲染器
    let config = RenderConfig {
        window_title: "Shank Render Demo".to_string(),
        width: 1024,
        height: 768,
        vsync: true,
        ..Default::default()
    };
    
    let mut renderer = Renderer::new(config).expect("Failed to create renderer");
    
    // 2. 创建网格
    let vertices = vec![
        Vertex { position: [0.0, 0.5, 0.0], color: [1.0, 0.0, 0.0] },    // 红色顶点
        Vertex { position: [-0.5, -0.5, 0.0], color: [0.0, 1.0, 0.0] },  // 绿色顶点
        Vertex { position: [0.5, -0.5, 0.0], color: [0.0, 0.0, 1.0] },   // 蓝色顶点
    ];
    
    let indices = vec![0, 1, 2];
    let mesh = renderer.create_mesh(&vertices, &indices).unwrap();
    
    // 3. 创建着色器
    let vertex_shader = r#"
        #version 450
        layout(location = 0) in vec3 position;
        layout(location = 1) in vec3 color;
        
        layout(location = 0) out vec3 v_color;
        
        void main() {
            gl_Position = vec4(position, 1.0);
            v_color = color;
        }
    "#;
    
    let fragment_shader = r#"
        #version 450
        layout(location = 0) in vec3 v_color;
        layout(location = 0) out vec4 out_color;
        
        void main() {
            out_color = vec4(v_color, 1.0);
        }
    "#;
    
    let shader = renderer.create_shader(vertex_shader, fragment_shader).unwrap();
    
    // 4. 创建后处理效果
    let mut post_effects = PostEffectChain::new();
    post_effects.add(Box::new(BloomEffect::new(0.7)));
    
    // 5. 主渲染循环
    while !renderer.should_close() {
        renderer.begin_frame();
        
        // 设置着色器
        renderer.set_shader(&shader);
        
        // 绘制网格
        renderer.draw_mesh(&mesh, Transform::identity());
        
        // 应用后处理效果
        renderer.apply_post_effects(&post_effects);
        
        renderer.end_frame();
    }
}

项目结构说明

要实现上述示例，建议按照以下结构组织项目：

shank_demo/
├── Cargo.toml
├── assets/
│   └── shaders/
│       ├── basic.vert    # 顶点着色器
│       └── basic.frag    # 片段着色器
└── src/
    ├── main.rs          # 主程序入口
    └── renderer.rs      # 渲染器封装

进阶示例：带纹理的3D立方体

use shank_render::{
    Renderer, RenderConfig, 
    Vertex, Transform, Texture,
    MaterialBuilder
};

fn main() {
    // 初始化渲染器
    let config = RenderConfig {
        window_title: "3D Cube Demo".to_string(),
        width: 1024,
        height: 768,
        ..Default::default()
    };
    
    let mut renderer = Renderer::new(config).unwrap();
    
    // 创建立方体网格 (简化版，实际应有36个顶点)
    let vertices = create_cube_vertices();
    let indices = create_cube_indices();
    let mesh = renderer.create_mesh(&vertices, &indices).unwrap();
    
    // 加载纹理
    let texture = renderer.load_texture("assets/crate.png").unwrap();
    
    // 创建材质
    let material = MaterialBuilder::new()
        .with_texture("diffuse", &texture)
        .build();
    
    // 主循环
    while !renderer.should_close() {
        renderer.begin_frame();
        
        // 旋转立方体
        let mut transform = Transform::identity();
        transform.rotate_y(0.01);
        
        // 绘制带纹理的立方体
        renderer.draw_mesh_with_material(&mesh, &material, transform);
        
        renderer.end_frame();
    }
}

fn create_cube_vertices() -> Vec<Vertex> {
    // 实际实现应包含8个顶点，每个面2个三角形
    vec![
        Vertex { position: [-0.5, -0.5, -0.5], tex_coords: [0.0, 0.0], ..Default::default() },
        Vertex { position: [0.5, -0.5, -0.5], tex_coords: [1.0, 0.0], ..Default::default() },
        // 更多顶点...
    ]
}

fn create_cube_indices() -> Vec<u32> {
    // 36个索引 (6个面 × 2个三角形 × 3个顶点)
    vec![0, 1, 2, /* 更多索引... */]
}

性能优化建议

1. 批处理渲染：将多个小物体的绘制合并到一个批次中
2. 实例化渲染：对大量重复物体使用实例化渲染
3. 纹理图集：将多个小纹理合并为大纹理图集
4. LOD系统：根据距离使用不同细节层次的模型

常见问题解答

Q: 如何实现透明效果？ A: 在片段着色器中设置输出颜色的alpha值小于1.0，并确保启用了混合功能

Q: 如何实现光照？ A: 可以在着色器中添加光照计算，或使用shank_render的内置光照系统

Q: 如何调试着色器错误？ A: 检查着色器编译日志，确保语法正确，所有变量都已正确定义和使用