Struct GPUBuilder

pub struct GPUBuilder<'a> { /* private fields */ }

Implementations

impl<'a> GPUBuilder<'a>

pub fn set_window(self, window: &'a mut Window) -> Self

Sets the window for this GPU instance.

This is useful for creating a GPU instance that is bound to a specific window. The window must be created before this GPU instance.

pub fn set_adapter(self, adapter: &'a GPUAdapter) -> Self

Sets the GPU adapter for this GPU instance.

This is useful for creating a GPU instance that uses a specific GPU adapter. The adapter can be queried using the Engine::query_gpu_adapter function.

Examples found in repository

examples/gpu_adapter.rs (line 30)

fn main() {
    let mut runner = est_render::runner::new().expect("Failed to create runner");
    let mut window = runner
        .create_window("Engine Example", Point2::new(800, 600))
        .build()
        .expect("Failed to create window");

    let adapters = est_render::gpu::query_gpu_adapter(Some(&window));
    if adapters.is_empty() {
        eprintln!("No GPU adapters found. Exiting.");
        return;
    }

    let selected_adapter = adapters
        .iter()
        .find(|adapter| adapter.backend_enum == AdapterBackend::Vulkan)
        .cloned();

    if selected_adapter.is_none() {
        eprintln!("No suitable GPU adapter found. Exiting.");
        return;
    }

    let adapter = selected_adapter.unwrap();
    let mut gpu = est_render::gpu::new(Some(&mut window))
        .set_adapter(&adapter)
        .build()
        .expect("Failed to create GPU");

    while runner.pool_events(None) {
        for event in runner.get_events() {
            match event {
                Event::WindowClosed { .. } => {
                    return;
                }
                _ => {}
            }
        }

        if let Ok(mut cmd) = gpu.begin_command() {
            if let Ok(mut rp) = cmd.begin_renderpass() {
                rp.set_clear_color(Color::LIGHTBLUE);
            }
        }
    }
}

pub fn set_limits(self, limits: Limits) -> Self

pub fn build(self) -> Result<GPU, String>

Examples found in repository

examples/clear_color.rs (line 14)

fn main() {
    let mut runner = est_render::runner::new().expect("Failed to create runner");

    let mut window = runner
        .create_window("Clear Color Example", Point2::new(800, 600))
        .build()
        .expect("Failed to create window");

    let mut gpu = est_render::gpu::new(Some(&mut window))
        .build()
        .expect("Failed to create GPU");

    while runner.pool_events(None) {
        for event in runner.get_events() {
            match event {
                Event::WindowClosed { .. } => {
                    return;
                }
                _ => {}
            }
        }

        if let Ok(mut cmd) = gpu.begin_command() {
            let surface = cmd.get_surface_texture();
            if surface.is_err() {
                println!("Failed to get surface texture: {:?}", surface.err());
                continue;
            }

            // Or you could use `cmd.begin_renderpass()` directly
            if let Ok(mut rp) = cmd.renderpass_builder()
                .add_surface_color_attachment(surface.as_ref().unwrap(), Some(&BlendState::ALPHA_BLEND))
                .build() 
            {
                rp.set_clear_color(Color::BLUE);
            }
        }
    }
}

examples/gpu_adapter.rs (line 31)

fn main() {
    let mut runner = est_render::runner::new().expect("Failed to create runner");
    let mut window = runner
        .create_window("Engine Example", Point2::new(800, 600))
        .build()
        .expect("Failed to create window");

    let adapters = est_render::gpu::query_gpu_adapter(Some(&window));
    if adapters.is_empty() {
        eprintln!("No GPU adapters found. Exiting.");
        return;
    }

    let selected_adapter = adapters
        .iter()
        .find(|adapter| adapter.backend_enum == AdapterBackend::Vulkan)
        .cloned();

    if selected_adapter.is_none() {
        eprintln!("No suitable GPU adapter found. Exiting.");
        return;
    }

    let adapter = selected_adapter.unwrap();
    let mut gpu = est_render::gpu::new(Some(&mut window))
        .set_adapter(&adapter)
        .build()
        .expect("Failed to create GPU");

    while runner.pool_events(None) {
        for event in runner.get_events() {
            match event {
                Event::WindowClosed { .. } => {
                    return;
                }
                _ => {}
            }
        }

        if let Ok(mut cmd) = gpu.begin_command() {
            if let Ok(mut rp) = cmd.begin_renderpass() {
                rp.set_clear_color(Color::LIGHTBLUE);
            }
        }
    }
}

examples/drawing.rs (line 14)

fn main() {
    let mut runner = est_render::runner::new().expect("Failed to create runner");

    let mut window = runner
        .create_window("Drawing Example", Point2::new(800, 600))
        .build()
        .expect("Failed to create window");

    let mut gpu = est_render::gpu::new(Some(&mut window))
        .build()
        .expect("Failed to create GPU");

    while runner.pool_events(None) {
        for event in runner.get_events() {
            match event {
                Event::WindowClosed { .. } => {
                    return;
                }
                _ => {}
            }
        }

        if let Ok(mut cmd) = gpu.begin_command() {
            if let Ok(mut gp) = cmd.begin_renderpass() {
                gp.set_clear_color(Color::BLUE); // Set the clear color to blue

                gp.set_blend(0, Some(&BlendState::ALPHA_BLEND));
                if let Some(mut drawing) = gp.begin_drawing() {
                    drawing.draw_rect_filled(
                        Vector2::new(100.0, 100.0),
                        Vector2::new(200.0, 200.0),
                        Color::RED,
                    );

                    drawing.draw_circle_filled(Vector2::new(400.0, 300.0), 50.0, 25, Color::GREEN);
                }

                gp.set_blend(0, Some(&BlendState::ADDITIVE_BLEND));
                if let Some(mut drawing) = gp.begin_drawing() {
                    drawing.draw_text(
                        "Hello, World!",
                        Vector2::new(300.0, 500.0),
                        Color::WHITE,
                    );
                }
            }
        }
    }
}

examples/font.rs (line 14)

fn main() {
    let mut runner = est_render::runner::new().expect("Failed to create runner");

    let mut window = runner
        .create_window("Font Example", Point2::new(800, 600))
        .build()
        .expect("Failed to create window");

    let mut gpu = est_render::gpu::new(Some(&mut window))
        .build()
        .expect("Failed to create GPU");

    let mut font_manager = est_render::font::new();

    let font = font_manager
        .load_font("Arial", None, 20.0)
        .expect("Failed to load font");

    // Generate baked text texture
    let texture = font
        .create_baked_text(&mut gpu, "Hello, World!\nThis is a clear color example.")
        .expect("Failed to create baked text");

    while runner.pool_events(None) {
        for event in runner.get_events() {
            match event {
                Event::WindowClosed { .. } => {
                    return;
                }
                _ => {}
            }
        }

        if let Ok(mut cmd) = gpu.begin_command() {
            if let Ok(mut gp) = cmd.begin_renderpass() {
                gp.set_clear_color(Color::BLUE);

                // The best texture blend for font rendering, others may has artifacts like black borders
                gp.set_blend(0, Some(&BlendState::ADDITIVE_BLEND));
                
                if let Some(mut drawing) = gp.begin_drawing() {
                    let size: Vector2 = texture.size().into();

                    // Baked text rendering
                    drawing.set_texture(Some(&texture));
                    drawing.draw_rect_image(Vector2::new(0.0, 0.0), size, Color::WHITE);

                    // Online text rendering
                    drawing.set_font(&font);
                    drawing.draw_text(
                        "Hello, World!\nThis is a clear color example.",
                        Vector2::new(size.x, 0.0),
                        Color::WHITE,
                    );
                }
            }
        }
    }
}

examples/texture_atlas.rs (line 14)

fn main() {
    let mut runner = est_render::runner::new().expect("Failed to create runner");

    let mut window = runner
        .create_window("Clear Color Example", Point2::new(800, 600))
        .build()
        .expect("Failed to create window");

    let mut gpu = est_render::gpu::new(Some(&mut window))
        .build()
        .expect("Failed to create GPU");

    let texture_atlas = gpu
        .create_texture_atlas()
        .add_texture_file(
            "example_texture",
            "./examples/resources/test1.png",
        )
        .add_texture_file(
            "example_texture2",
            "./examples/resources/test2.png",
        )
        .build()
        .expect("Failed to create texture atlas");

    while runner.pool_events(None) {
        for event in runner.get_events() {
            match event {
                Event::WindowClosed { .. } => {
                    return;
                }
                _ => {}
            }
        }

        if let Ok(mut cmd) = gpu.begin_command() {
            if let Ok(mut gp) = cmd.begin_renderpass() {
                gp.set_clear_color(Color::BLUEVIOLET);
                gp.set_blend(0, Some(&BlendState::NONE));

                if let Some(mut drawing) = gp.begin_drawing() {
                    drawing.set_texture_atlas(Some((&texture_atlas, "example_texture")));
                    drawing.draw_rect_image(
                        Vector2::new(100.0, 100.0),
                        Vector2::new(200.0, 200.0),
                        Color::WHITE,
                    );
                    drawing.set_texture_atlas(Some((&texture_atlas, "example_texture2")));
                    drawing.draw_rect_image(
                        Vector2::new(350.0, 100.0),
                        Vector2::new(200.0, 200.0),
                        Color::WHITE,
                    );
                    drawing.draw_circle_image(Vector2::new(600.0, 200.0), 100.0, 20, Color::WHITE);
                }
            }
        }
    }
}

examples/msaa.rs (line 13)

fn main() {
    let mut runner = est_render::runner::new().expect("Failed to create runner");
    let mut window = runner
        .create_window("Engine Example", Point2::new(800, 600))
        .build()
        .expect("Failed to create window");

    let mut gpu = est_render::gpu::new(Some(&mut window))
        .build()
        .expect("Failed to create GPU");

    let mut msaa_texture = Some(
        gpu.create_texture()
            .set_render_target(Point2::new(800, 600), None)
            .set_usage(TextureUsage::Sampler)
            .set_sample_count(SampleCount::SampleCount4)
            .build()
            .expect("Failed to create MSAA texture"),
    );

    let mut msaa_count = SampleCount::SampleCount4;
    let mut window_size = Point2::new(800, 600);

    while runner.pool_events(None) {
        for event in runner.get_events() {
            match event {
                Event::WindowClosed { .. } => {
                    return;
                }
                Event::KeyboardInput { key, pressed, .. } => {
                    if !*pressed {
                        continue;
                    }

                    let mut need_recreate = false;
                    if *key == "1" {
                        msaa_count = SampleCount::SampleCount1;
                        need_recreate = true;
                    }

                    if *key == "2" {
                        msaa_count = SampleCount::SampleCount2;
                        need_recreate = true;
                    }

                    if *key == "3" {
                        msaa_count = SampleCount::SampleCount4;
                        need_recreate = true;
                    }

                    if *key == "4" {
                        msaa_count = SampleCount::SampleCount8;
                        need_recreate = true;
                    }

                    if need_recreate {
                        if msaa_count == SampleCount::SampleCount1 {
                            msaa_texture = None;
                        } else {
                            msaa_texture = Some(
                                gpu.create_texture()
                                    .set_render_target(
                                        Point2::new(window_size.x, window_size.y),
                                        None,
                                    )
                                    .set_usage(TextureUsage::Sampler)
                                    .set_sample_count(msaa_count)
                                    .build()
                                    .expect("Failed to recreate MSAA texture"),
                            );
                        }
                    }
                }
                Event::WindowResized { size, .. } => {
                    if size.x <= 0 || size.y <= 0 {
                        eprintln!("Invalid window size: {:?}", size);
                        continue;
                    }

                    window_size = *size;

                    // Resize the MSAA texture to match the new window size
                    msaa_texture = Some(
                        gpu.create_texture()
                            .set_render_target(Point2::new(size.x, size.y), None)
                            .set_usage(TextureUsage::Sampler)
                            .set_sample_count(msaa_count)
                            .build()
                            .expect("Failed to resize MSAA texture"),
                    );
                }
                _ => {}
            }
        }

        if let Ok(mut cmd) = gpu.begin_command() {
            if let Ok(mut rp) = cmd.begin_renderpass() {
                rp.set_clear_color(Color::BLACK);
                if let Some(texture) = msaa_texture.as_ref() {
                    rp.push_msaa_texture(texture);
                }

                if let Some(mut drawing) = rp.begin_drawing() {
                    let pos1 = Vector2::new(0.0, 0.0);
                    let pos2 = Vector2::new(800.0, 0.0);
                    let pos3 = Vector2::new(400.0, 600.0);

                    // Draw a full triangle covering the window
                    drawing.draw_triangle_filled(pos1, pos2, pos3, Color::BLUE);
                }
            }
        }
    }
}

Additional examples can be found in:

• examples/pipeline.rs