Struct ViewportTexture 

pub struct ViewportTexture { /* private fields */ }

A viewport selection texture for the compute bundle created by selection::create_viewport_bundle.

Implementations

impl ViewportTexture

pub fn new(device: &Device, size: UVec2) -> Self

Create a new viewport texture.

pub fn texture(&self) -> &Texture

Get the texture.

pub fn view(&self) -> &TextureView

Get the texture view.

Examples found in repository

examples/utils/selection.rs (line 66)

    pub fn new(
        device: &wgpu::Device,
        texture_format: wgpu::TextureFormat,
        viewport_texture: &ViewportTexture,
    ) -> Self {
        log::debug!("Creating selection viewport texture overlay renderer sampler");
        let sampler = device.create_sampler(&wgpu::SamplerDescriptor {
            label: Some("Selection Viewport Texture Overlay Renderer Sampler"),
            ..Default::default()
        });

        log::debug!("Creating selection viewport texture overlay renderer bind group layout");
        let bind_group_layout =
            device.create_bind_group_layout(&Self::BIND_GROUP_LAYOUT_DESCRIPTOR);

        log::debug!("Creating selection viewport texture overlay renderer bind group");
        let bind_group = device.create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some("Selection Viewport Texture Overlay Renderer Bind Group"),
            layout: &bind_group_layout,
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: wgpu::BindingResource::TextureView(viewport_texture.view()),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: wgpu::BindingResource::Sampler(&sampler),
                },
            ],
        });

        log::debug!("Creating selection viewport texture overlay renderer pipeline layout");
        let pipeline_layout = device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor {
            label: Some("Selection Viewport Texture Overlay Renderer Pipeline Layout"),
            bind_group_layouts: &[&bind_group_layout],
            ..Default::default()
        });

        log::debug!("Creating selection viewport texture overlay renderer shader");
        let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor {
            label: Some("Selection Viewport Texture Overlay Renderer Shader"),
            source: wgpu::ShaderSource::Wgsl(
                include_str!("../shader/selection/viewport_texture_overlay.wgsl").into(),
            ),
        });

        log::debug!("Creating selection viewport texture overlay renderer pipeline");
        let pipeline = device.create_render_pipeline(&wgpu::RenderPipelineDescriptor {
            label: Some("Selection Viewport Texture Overlay Renderer Pipeline"),
            layout: Some(&pipeline_layout),
            vertex: wgpu::VertexState {
                module: &shader,
                entry_point: Some("vert_main"),
                buffers: &[],
                compilation_options: wgpu::PipelineCompilationOptions::default(),
            },
            fragment: Some(wgpu::FragmentState {
                module: &shader,
                entry_point: Some("frag_main"),
                targets: &[Some(wgpu::ColorTargetState {
                    format: texture_format,
                    blend: Some(wgpu::BlendState::ALPHA_BLENDING),
                    write_mask: wgpu::ColorWrites::ALL,
                })],
                compilation_options: wgpu::PipelineCompilationOptions::default(),
            }),
            primitive: wgpu::PrimitiveState::default(),
            depth_stencil: None,
            multisample: wgpu::MultisampleState::default(),
            multiview_mask: None,
            cache: None,
        });

        Self {
            sampler,
            bind_group_layout,
            bind_group,
            pipeline,
        }
    }

    /// Update the bind group.
    ///
    /// This is specifically for updating the selection viewport texture size.
    pub fn update_bind_group(&mut self, device: &wgpu::Device, viewport_texture: &ViewportTexture) {
        self.bind_group = device.create_bind_group(&wgpu::BindGroupDescriptor {
            label: Some("Selection Viewport Texture Overlay Renderer Bind Group"),
            layout: &self.bind_group_layout,
            entries: &[
                wgpu::BindGroupEntry {
                    binding: 0,
                    resource: wgpu::BindingResource::TextureView(viewport_texture.view()),
                },
                wgpu::BindGroupEntry {
                    binding: 1,
                    resource: wgpu::BindingResource::Sampler(&self.sampler),
                },
            ],
        });
    }

examples/selection.rs (line 209)

    async fn init(window: Arc<Window>, args: &Args) -> Self {
        let model_path = &args.model;
        let filter = args.filter;
        let immediate = args.immediate;
        let size = window.inner_size();

        log::debug!("Creating wgpu instance");
        let instance = wgpu::Instance::new(&wgpu::InstanceDescriptor::default());

        log::debug!("Creating window surface");
        let surface = instance.create_surface(window.clone()).expect("surface");

        log::debug!("Requesting adapter");
        let adapter = instance
            .request_adapter(&wgpu::RequestAdapterOptions {
                power_preference: wgpu::PowerPreference::HighPerformance,
                compatible_surface: Some(&surface),
                force_fallback_adapter: false,
            })
            .await
            .expect("adapter");

        log::debug!("Requesting device");
        let (device, queue) = adapter
            .request_device(&wgpu::DeviceDescriptor {
                label: Some("Device"),
                required_limits: adapter.limits(),
                ..Default::default()
            })
            .await
            .expect("device");

        let surface_caps = surface.get_capabilities(&adapter);
        let surface_format = surface_caps.formats[0];
        let config = wgpu::SurfaceConfiguration {
            usage: wgpu::TextureUsages::RENDER_ATTACHMENT,
            format: surface_format,
            width: size.width.max(1),
            height: size.height.max(1),
            present_mode: surface_caps.present_modes[0],
            alpha_mode: surface_caps.alpha_modes[0],
            view_formats: vec![surface_format.remove_srgb_suffix()],
            desired_maximum_frame_latency: 2,
        };

        log::debug!("Configuring surface");
        surface.configure(&device, &config);

        log::debug!("Creating gaussians");
        let gaussians = [GaussiansSource::Ply, GaussiansSource::Spz]
            .into_iter()
            .find_map(|source| gs::core::Gaussians::read_from_file(model_path, source).ok())
            .expect("gaussians");

        log::debug!("Creating camera");
        let camera = gs::Camera::new(0.1..1e4, 60f32.to_radians());

        log::debug!("Creating viewer");
        let mut viewer = gs::Viewer::new_with_options(
            &device,
            config.view_formats[0],
            &gaussians,
            gs::ViewerCreateOptions {
                gaussians_buffer_usage:
                    gs::core::GaussiansBuffer::<gs::DefaultGaussianPod>::DEFAULT_USAGES
                        | wgpu::BufferUsages::COPY_SRC,
                ..Default::default()
            },
        )
        .expect("viewer");
        viewer.update_model_transform(
            &queue,
            Vec3::ZERO,
            Quat::from_axis_angle(Vec3::Z, 180f32.to_radians()),
            Vec3::ONE,
        );

        log::debug!("Creating selector");
        let mut selector = gs::selection::ViewportSelector::new(
            &device,
            &queue,
            UVec2::new(size.width, size.height),
            &viewer.camera_buffer,
        )
        .expect("selector");
        selector.selector_type = gs::selection::ViewportSelectorType::Brush;

        log::debug!("Creating selection viewport selection modifier");
        let mut viewport_selection_modifier = gs::editor::NonDestructiveModifier::new(
            &device,
            &queue,
            gs::editor::BasicSelectionModifier::new_with_basic_modifier(
                &device,
                &viewer.gaussians_buffer,
                &viewer.model_transform_buffer,
                &viewer.gaussian_transform_buffer,
                vec![gs::selection::create_viewport_bundle::<
                    gs::DefaultGaussianPod,
                >(&device)],
            ),
            &viewer.gaussians_buffer,
        )
        .expect("modifier");

        let viewport_selection_bind_group = viewport_selection_modifier.modifier.selection.bundles
            [0]
        .create_bind_group(
            &device,
            // index 0 is the Gaussians buffer, so we use 1,
            // see docs of create_viewport_bundle
            1,
            [
                viewer.camera_buffer.buffer().as_entire_binding(),
                wgpu::BindingResource::TextureView(selector.texture().view()),
            ],
        )
        .expect("bind group");

        viewport_selection_modifier.modifier.selection_expr =
            gs::editor::SelectionExpr::Selection(0, vec![viewport_selection_bind_group]);

        viewport_selection_modifier // Non destructive modifier
            .modifier // Selection modifier
            .modifier // Basic modifier
            .basic_color_modifiers_buffer
            .update_with_pod(
                &queue,
                &gs::editor::BasicColorModifiersPod {
                    rgb_or_hsv: BasicColorRgbOverrideOrHsvModifiersPod::new_rgb_override(
                        Vec3::new(1.0, 1.0, 0.0),
                    ),
                    ..Default::default()
                },
            );

        log::debug!("Creating selection viewport texture overlay renderer");
        let viewport_texture_overlay_renderer =
            utils::selection::ViewportTextureOverlayRenderer::new(
                &device,
                config.view_formats[0],
                selector.texture(),
            );

        log::info!("System initialized");

        Self {
            surface,
            device,
            queue,
            config,

            filter,
            immediate,
            inverted: filter,
            selector_type: None,

            camera,
            gaussians,
            viewer,
            selector,

            viewport_selection_modifier,
            viewport_texture_overlay_renderer,
        }
    }

    fn update(&mut self, input: &core::Input, delta_time: f32) {
        // Toggle selection mode
        if input.pressed_keys.contains(&KeyCode::KeyN) {
            self.selector_type = None;
            log::info!("Selector: None");
        }
        if input.pressed_keys.contains(&KeyCode::KeyR) {
            self.selector_type = Some(gs::selection::ViewportSelectorType::Rectangle);
            log::info!("Selector: Rectangle");
            self.selector.selector_type = gs::selection::ViewportSelectorType::Rectangle;
        }
        if input.pressed_keys.contains(&KeyCode::KeyB) {
            self.selector_type = Some(gs::selection::ViewportSelectorType::Brush);
            log::info!("Selector: Brush");
            self.selector.selector_type = gs::selection::ViewportSelectorType::Brush;
        }
        if input.pressed_keys.contains(&KeyCode::KeyI) {
            self.inverted = !self.inverted;
            log::info!("Inverted: {}", self.inverted);
            if self.filter {
                self.viewer
                    .invert_selection_buffer
                    .update(&self.queue, self.inverted);
            }
        }

        if self.selector_type.is_some() {
            self.update_selection(input, delta_time);
        } else {
            self.update_movement(input, delta_time);
        }

        // Update the viewer
        self.viewer.update_camera(
            &self.queue,
            &self.camera,
            uvec2(self.config.width, self.config.height),
        );
    }

    fn render(&mut self) {
        let texture = match self.surface.get_current_texture() {
            Ok(texture) => texture,
            Err(e) => {
                log::error!("Failed to get current texture: {e:?}");
                return;
            }
        };
        let texture_view = texture.texture.create_view(&wgpu::TextureViewDescriptor {
            label: Some("Texture View"),
            format: Some(self.config.view_formats[0]),
            ..Default::default()
        });

        let mut encoder = self
            .device
            .create_command_encoder(&wgpu::CommandEncoderDescriptor {
                label: Some("Command Encoder"),
            });

        self.viewer.render(&mut encoder, &texture_view);

        if !self.immediate && self.selector_type.is_some() {
            self.viewport_texture_overlay_renderer
                .render(&mut encoder, &texture_view);
        }

        self.queue.submit(std::iter::once(encoder.finish()));
        if let Err(e) = self.device.poll(wgpu::PollType::wait_indefinitely()) {
            log::error!("Failed to poll device: {e:?}");
        }
        texture.present();
    }

    fn resize(&mut self, size: winit::dpi::PhysicalSize<u32>) {
        if size.width > 0 && size.height > 0 {
            self.config.width = size.width;
            self.config.height = size.height;
            self.surface.configure(&self.device, &self.config);

            // Update selector viewport texture
            self.selector
                .resize(&self.device, UVec2::new(size.width, size.height));

            // Update viewport selection bundle
            let viewport_selection_bind_group =
                self.viewport_selection_modifier.modifier.selection.bundles[0]
                    .create_bind_group(
                        &self.device,
                        // index 0 is the Gaussians buffer, so we use 1,
                        // see docs of create_viewport_bundle
                        1,
                        [
                            self.viewer.camera_buffer.buffer().as_entire_binding(),
                            wgpu::BindingResource::TextureView(self.selector.texture().view()),
                        ],
                    )
                    .expect("bind group");

            // Update viewport selection modifier selection expr
            self.viewport_selection_modifier.modifier.selection_expr =
                gs::editor::SelectionExpr::Selection(0, vec![viewport_selection_bind_group]);

            // Update viewport texture overlay renderer
            self.viewport_texture_overlay_renderer
                .update_bind_group(&self.device, self.selector.texture());
        }
    }

Trait Implementations

impl Clone for ViewportTexture

fn clone(&self) -> ViewportTexture

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ViewportTexture

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.