servo/components/script/dom/gputexture.rs

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

use crate::dom::bindings::cell::DomRefCell;
use crate::dom::bindings::codegen::Bindings::GPUTextureBinding::{
    GPUExtent3DDict, GPUTextureDimension, GPUTextureFormat, GPUTextureMethods,
};
use crate::dom::bindings::codegen::Bindings::GPUTextureViewBinding::{
    GPUTextureAspect, GPUTextureViewDescriptor, GPUTextureViewDimension,
};
use crate::dom::bindings::reflector::{reflect_dom_object, DomObject, Reflector};
use crate::dom::bindings::root::{Dom, DomRoot};
use crate::dom::bindings::str::USVString;
use crate::dom::globalscope::GlobalScope;
use crate::dom::gpudevice::{convert_texture_format, convert_texture_view_dimension, GPUDevice};
use crate::dom::gputextureview::GPUTextureView;
use dom_struct::dom_struct;
use std::num::NonZeroU32;
use std::string::String;
use webgpu::{
    identity::WebGPUOpResult, wgt, WebGPU, WebGPURequest, WebGPUTexture, WebGPUTextureView,
};

#[dom_struct]
pub struct GPUTexture {
    reflector_: Reflector,
    texture: WebGPUTexture,
    label: DomRefCell<Option<USVString>>,
    device: Dom<GPUDevice>,
    #[ignore_malloc_size_of = "channels are hard"]
    channel: WebGPU,
    #[ignore_malloc_size_of = "defined in webgpu"]
    texture_size: GPUExtent3DDict,
    mip_level_count: u32,
    sample_count: u32,
    dimension: GPUTextureDimension,
    format: GPUTextureFormat,
    texture_usage: u32,
}

impl GPUTexture {
    fn new_inherited(
        texture: WebGPUTexture,
        device: &GPUDevice,
        channel: WebGPU,
        texture_size: GPUExtent3DDict,
        mip_level_count: u32,
        sample_count: u32,
        dimension: GPUTextureDimension,
        format: GPUTextureFormat,
        texture_usage: u32,
        label: Option<USVString>,
    ) -> Self {
        Self {
            reflector_: Reflector::new(),
            texture,
            label: DomRefCell::new(label),
            device: Dom::from_ref(device),
            channel,
            texture_size,
            mip_level_count,
            sample_count,
            dimension,
            format,
            texture_usage,
        }
    }

    pub fn new(
        global: &GlobalScope,
        texture: WebGPUTexture,
        device: &GPUDevice,
        channel: WebGPU,
        texture_size: GPUExtent3DDict,
        mip_level_count: u32,
        sample_count: u32,
        dimension: GPUTextureDimension,
        format: GPUTextureFormat,
        texture_usage: u32,
        label: Option<USVString>,
    ) -> DomRoot<Self> {
        reflect_dom_object(
            Box::new(GPUTexture::new_inherited(
                texture,
                device,
                channel,
                texture_size,
                mip_level_count,
                sample_count,
                dimension,
                format,
                texture_usage,
                label,
            )),
            global,
        )
    }
}

impl Drop for GPUTexture {
    fn drop(&mut self) {
        self.Destroy()
    }
}

impl GPUTexture {
    pub fn id(&self) -> WebGPUTexture {
        self.texture
    }
}

impl GPUTextureMethods for GPUTexture {
    /// https://gpuweb.github.io/gpuweb/#dom-gpuobjectbase-label
    fn GetLabel(&self) -> Option<USVString> {
        self.label.borrow().clone()
    }

    /// https://gpuweb.github.io/gpuweb/#dom-gpuobjectbase-label
    fn SetLabel(&self, value: Option<USVString>) {
        *self.label.borrow_mut() = value;
    }

    /// https://gpuweb.github.io/gpuweb/#dom-gputexture-createview
    fn CreateView(&self, descriptor: &GPUTextureViewDescriptor) -> DomRoot<GPUTextureView> {
        let dimension = if let Some(d) = descriptor.dimension {
            d
        } else {
            match self.dimension {
                GPUTextureDimension::_1d => GPUTextureViewDimension::_1d,
                GPUTextureDimension::_2d => {
                    if self.texture_size.depth > 1 && descriptor.arrayLayerCount.is_none() {
                        GPUTextureViewDimension::_2d_array
                    } else {
                        GPUTextureViewDimension::_2d
                    }
                },
                GPUTextureDimension::_3d => GPUTextureViewDimension::_3d,
            }
        };

        let format = descriptor.format.unwrap_or(self.format);
        let scope_id = self.device.use_current_scope();
        let mut valid = true;
        let level_count = descriptor.mipLevelCount.and_then(|count| {
            if count == 0 {
                valid = false;
            }
            NonZeroU32::new(count)
        });
        let array_layer_count = descriptor.arrayLayerCount.and_then(|count| {
            if count == 0 {
                valid = false;
            }
            NonZeroU32::new(count)
        });

        let desc = if valid {
            Some(wgt::TextureViewDescriptor {
                label: descriptor
                    .parent
                    .label
                    .as_ref()
                    .map(|s| String::from(s.as_ref())),
                format: convert_texture_format(format),
                dimension: convert_texture_view_dimension(dimension),
                aspect: match descriptor.aspect {
                    GPUTextureAspect::All => wgt::TextureAspect::All,
                    GPUTextureAspect::Stencil_only => wgt::TextureAspect::StencilOnly,
                    GPUTextureAspect::Depth_only => wgt::TextureAspect::DepthOnly,
                },
                base_mip_level: descriptor.baseMipLevel,
                level_count,
                base_array_layer: descriptor.baseArrayLayer,
                array_layer_count,
            })
        } else {
            self.device.handle_server_msg(
                scope_id,
                WebGPUOpResult::ValidationError(String::from(
                    "arrayLayerCount and mipLevelCount cannot be 0",
                )),
            );
            None
        };

        let texture_view_id = self
            .global()
            .wgpu_id_hub()
            .lock()
            .create_texture_view_id(self.device.id().0.backend());

        self.channel
            .0
            .send((
                scope_id,
                WebGPURequest::CreateTextureView {
                    texture_id: self.texture.0,
                    texture_view_id,
                    device_id: self.device.id().0,
                    descriptor: desc,
                },
            ))
            .expect("Failed to create WebGPU texture view");

        let texture_view = WebGPUTextureView(texture_view_id);

        GPUTextureView::new(
            &self.global(),
            texture_view,
            &self,
            descriptor.parent.label.as_ref().cloned(),
        )
    }

    /// https://gpuweb.github.io/gpuweb/#dom-gputexture-destroy
    fn Destroy(&self) {
        if let Err(e) = self
            .channel
            .0
            .send((None, WebGPURequest::DestroyTexture(self.texture.0)))
        {
            warn!(
                "Failed to send WebGPURequest::DestroyTexture({:?}) ({})",
                self.texture.0, e
            );
        };
    }
}