src/dawn/native/TexelBufferView.cpp

// Copyright 2025 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include "src/dawn/native/TexelBufferView.h"

#include "dawn/native/ObjectType_autogen.h"
#include "src/dawn/native/Buffer.h"
#include "src/dawn/native/ChainUtils.h"
#include "src/dawn/native/Device.h"

namespace dawn::native {

// Supported Texel buffer formats proposed in
// https://github.com/gpuweb/gpuweb/blob/main/proposals/texel-buffers.md#plain-color-formats
bool IsFormatSupportedForTexelBuffer(wgpu::TextureFormat format) {
    switch (format) {
        case wgpu::TextureFormat::RGBA8Unorm:
        case wgpu::TextureFormat::RGBA8Uint:
        case wgpu::TextureFormat::RGBA8Sint:
        case wgpu::TextureFormat::RGBA16Uint:
        case wgpu::TextureFormat::RGBA16Sint:
        case wgpu::TextureFormat::RGBA16Float:
        case wgpu::TextureFormat::R32Uint:
        case wgpu::TextureFormat::R32Sint:
        case wgpu::TextureFormat::R32Float:
        case wgpu::TextureFormat::RGBA32Uint:
        case wgpu::TextureFormat::RGBA32Sint:
        case wgpu::TextureFormat::RGBA32Float:
            return true;
        default:
            return false;
    }
}

ResultOrError<const Format*> ValidateTexelBufferFormat(DeviceBase* device,
                                                       wgpu::TextureFormat format) {
    DAWN_INVALID_IF(format == wgpu::TextureFormat::Undefined, "Texel buffer format is undefined.");

    const Format* internalFormat = nullptr;
    DAWN_TRY_ASSIGN(internalFormat, device->GetInternalFormat(format));

    DAWN_INVALID_IF(!IsFormatSupportedForTexelBuffer(format),
                    "Texel buffer format (%s) is not allowed for texel buffers.", format);
    return internalFormat;
}

TexelBufferViewBase::TexelBufferViewBase(BufferBase* buffer,
                                         const UnpackedPtr<TexelBufferViewDescriptor>& desc)
    : ApiObjectBase(buffer->GetDevice(), desc->label),
      mBuffer(buffer),
      mFormat(desc->format),
      mOffset(desc->offset),
      mSize(desc->size) {
    GetObjectTrackingList()->Track(this);
}

TexelBufferViewBase::TexelBufferViewBase(DeviceBase* device,
                                         ObjectBase::ErrorTag tag,
                                         StringView label)
    : ApiObjectBase(device, tag, label) {}

TexelBufferViewBase::~TexelBufferViewBase() = default;

Ref<TexelBufferViewBase> TexelBufferViewBase::MakeError(DeviceBase* device, StringView label) {
    return AcquireRef(new TexelBufferViewBase(device, ObjectBase::kError, label));
}

ObjectType TexelBufferViewBase::GetType() const {
    return ObjectType::TexelBufferView;
}

BufferBase* TexelBufferViewBase::GetBuffer() const {
    DAWN_ASSERT(!IsError());
    return mBuffer.Get();
}

wgpu::TextureFormat TexelBufferViewBase::GetFormat() const {
    DAWN_ASSERT(!IsError());
    return mFormat;
}

uint64_t TexelBufferViewBase::GetOffset() const {
    DAWN_ASSERT(!IsError());
    return mOffset;
}

uint64_t TexelBufferViewBase::GetSize() const {
    DAWN_ASSERT(!IsError());
    return mSize;
}

void TexelBufferViewBase::DestroyImpl(DestroyReason reason) {}

ApiObjectList* TexelBufferViewBase::GetObjectTrackingList() {
    if (mBuffer != nullptr) {
        return mBuffer->GetTexelBufferViewTrackingList();
    }
    return ApiObjectBase::GetObjectTrackingList();
}

}  // namespace dawn::native