Struct Scene 

pub struct Scene {
    pub background: Option<Box<dyn Shader>>,
    pub lights: Vec<Light>,
    pub d3_static: Vec<Batch<[f32; 4]>>,
    pub d3_dynamic: Vec<Batch<[f32; 4]>>,
    pub d2: Vec<Batch<[f32; 3]>>,
    pub textures: Vec<Texture>,
}

A scene of 2D and 3D batches which are passed to the rasterizer for rasterization.

Fields

background: Option<Box<dyn Shader>>

lights: Vec<Light>

d3_static: Vec<Batch<[f32; 4]>>

3D static batches which do not need to be changed, i.e. no animation for textures or the mesh itself.

d3_dynamic: Vec<Batch<[f32; 4]>>

3D dynamic batches which can be updated dynamically.

d2: Vec<Batch<[f32; 3]>>

The 2D batches get rendered on top of the 3D batches (2D game or UI).

textures: Vec<Texture>

The list of textures which the batches index into.

Implementations

impl Scene

pub fn empty() -> Self

pub fn from_static(d2: Vec<Batch<[f32; 3]>>, d3: Vec<Batch<[f32; 4]>>) -> Self

Examples found in repository

examples/cube.rs (lines 25-30)

    fn new() -> Self
    where
        Self: Sized,
    {
        let scene = Scene::from_static(
            vec![Batch::from_rectangle(0.0, 0.0, 200.0, 200.0)],
            vec![Batch::from_box(-0.5, -0.5, -0.5, 1.0, 1.0, 1.0)
                .sample_mode(SampleMode::Nearest)
                .cull_mode(CullMode::Off)],
        )
        .background(Box::new(VGrayGradientShader::new()))
        .textures(vec![Texture::from_image(Path::new("images/logo.png"))]);

        Self {
            camera: D3OrbitCamera::new(),
            scene,
        }
    }

examples/obj.rs (lines 25-31)

    fn new() -> Self
    where
        Self: Sized,
    {
        let scene = Scene::from_static(
            vec![Batch::from_rectangle(0.0, 0.0, 200.0, 200.0)],
            vec![Batch::from_obj(Path::new("examples/teapot.obj"))
                .sample_mode(SampleMode::Linear)
                .repeat_mode(RepeatMode::RepeatXY)
                .transform(Mat4::scaling_3d(Vec3::new(0.35, -0.35, 0.35)))],
        )
        .background(Box::new(VGrayGradientShader::new()))
        .textures(vec![Texture::from_image(Path::new("images/logo.png"))]);

        Self {
            camera: D3OrbitCamera::new(),
            scene,
        }
    }

pub fn background(self, background: Box<dyn Shader>) -> Self

Sets the background shader using the builder pattern.

Examples found in repository

examples/cube.rs (line 31)

    fn new() -> Self
    where
        Self: Sized,
    {
        let scene = Scene::from_static(
            vec![Batch::from_rectangle(0.0, 0.0, 200.0, 200.0)],
            vec![Batch::from_box(-0.5, -0.5, -0.5, 1.0, 1.0, 1.0)
                .sample_mode(SampleMode::Nearest)
                .cull_mode(CullMode::Off)],
        )
        .background(Box::new(VGrayGradientShader::new()))
        .textures(vec![Texture::from_image(Path::new("images/logo.png"))]);

        Self {
            camera: D3OrbitCamera::new(),
            scene,
        }
    }

examples/obj.rs (line 32)

    fn new() -> Self
    where
        Self: Sized,
    {
        let scene = Scene::from_static(
            vec![Batch::from_rectangle(0.0, 0.0, 200.0, 200.0)],
            vec![Batch::from_obj(Path::new("examples/teapot.obj"))
                .sample_mode(SampleMode::Linear)
                .repeat_mode(RepeatMode::RepeatXY)
                .transform(Mat4::scaling_3d(Vec3::new(0.35, -0.35, 0.35)))],
        )
        .background(Box::new(VGrayGradientShader::new()))
        .textures(vec![Texture::from_image(Path::new("images/logo.png"))]);

        Self {
            camera: D3OrbitCamera::new(),
            scene,
        }
    }

pub fn textures(self, textures: Vec<Texture>) -> Self

Sets the background shader using the builder pattern.

Examples found in repository

examples/cube.rs (line 32)

    fn new() -> Self
    where
        Self: Sized,
    {
        let scene = Scene::from_static(
            vec![Batch::from_rectangle(0.0, 0.0, 200.0, 200.0)],
            vec![Batch::from_box(-0.5, -0.5, -0.5, 1.0, 1.0, 1.0)
                .sample_mode(SampleMode::Nearest)
                .cull_mode(CullMode::Off)],
        )
        .background(Box::new(VGrayGradientShader::new()))
        .textures(vec![Texture::from_image(Path::new("images/logo.png"))]);

        Self {
            camera: D3OrbitCamera::new(),
            scene,
        }
    }

examples/obj.rs (line 33)

    fn new() -> Self
    where
        Self: Sized,
    {
        let scene = Scene::from_static(
            vec![Batch::from_rectangle(0.0, 0.0, 200.0, 200.0)],
            vec![Batch::from_obj(Path::new("examples/teapot.obj"))
                .sample_mode(SampleMode::Linear)
                .repeat_mode(RepeatMode::RepeatXY)
                .transform(Mat4::scaling_3d(Vec3::new(0.35, -0.35, 0.35)))],
        )
        .background(Box::new(VGrayGradientShader::new()))
        .textures(vec![Texture::from_image(Path::new("images/logo.png"))]);

        Self {
            camera: D3OrbitCamera::new(),
            scene,
        }
    }

pub fn lights(self, lights: Vec<Light>) -> Self

Sets the lights using the builder pattern.

pub fn project( &mut self, projection_matrix_2d: Option<Mat3<f32>>, view_matrix_3d: Mat4<f32>, projection_matrix_3d: Mat4<f32>, width: usize, height: usize, )

Project the batches using the given matrices (which represent the global camera).

Trait Implementations

impl Default for Scene

fn default() -> Self

Returns the “default value” for a type.