blitCmdsOps.h

//
// Copyright 2019 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_IMAGING_HGI_BLIT_CMDS_OPS_H
#define PXR_IMAGING_HGI_BLIT_CMDS_OPS_H

#include "pxr/pxr.h"
#include "pxr/base/gf/vec3i.h"
#include "pxr/imaging/hgi/api.h"
#include "pxr/imaging/hgi/buffer.h"
#include "pxr/imaging/hgi/enums.h"
#include "pxr/imaging/hgi/texture.h"
#include "pxr/imaging/hgi/types.h"

#include <stddef.h>

PXR_NAMESPACE_OPEN_SCOPE


struct HgiTextureGpuToCpuOp
{
    HgiTextureGpuToCpuOp()
    : gpuSourceTexture()
    , sourceTexelOffset(GfVec3i(0))
    , mipLevel(0)
    , cpuDestinationBuffer(nullptr)
    , destinationByteOffset(0)
    , destinationBufferByteSize(0)
    {}

    HgiTextureHandle gpuSourceTexture;
    GfVec3i sourceTexelOffset;
    uint32_t mipLevel;
    void* cpuDestinationBuffer;
    size_t destinationByteOffset;
    size_t destinationBufferByteSize;
};

struct HgiTextureCpuToGpuOp
{
    HgiTextureCpuToGpuOp()
    : cpuSourceBuffer(nullptr)
    , bufferByteSize(0)
    , destinationTexelOffset(GfVec3i(0))
    , mipLevel(0)
    , gpuDestinationTexture()
    {}

    void const* cpuSourceBuffer;
    size_t bufferByteSize;
    GfVec3i destinationTexelOffset;
    uint32_t mipLevel;
    HgiTextureHandle gpuDestinationTexture;
};

struct HgiBufferGpuToGpuOp
{
    HgiBufferGpuToGpuOp()
    : gpuSourceBuffer()
    , sourceByteOffset(0)
    , byteSize(0)
    , gpuDestinationBuffer()
    , destinationByteOffset(0)
    {}

    HgiBufferHandle gpuSourceBuffer;
    size_t sourceByteOffset;
    size_t byteSize;
    HgiBufferHandle gpuDestinationBuffer;
    size_t destinationByteOffset;
};


struct HgiBufferCpuToGpuOp
{
    HgiBufferCpuToGpuOp()
    : cpuSourceBuffer(nullptr)
    , sourceByteOffset(0)
    , gpuDestinationBuffer()
    , destinationByteOffset(0)
    , byteSize(0)
    {}

    void const* cpuSourceBuffer;
    size_t sourceByteOffset;
    HgiBufferHandle gpuDestinationBuffer;
    size_t destinationByteOffset;
    size_t byteSize;
};

struct HgiBufferGpuToCpuOp
{
    HgiBufferGpuToCpuOp()
    : gpuSourceBuffer()
    , sourceByteOffset(0)
    , byteSize(0)
    , cpuDestinationBuffer()
    , destinationByteOffset(0)
    {}

    HgiBufferHandle gpuSourceBuffer;
    size_t sourceByteOffset;
    size_t byteSize;
    void* cpuDestinationBuffer;
    size_t destinationByteOffset;
};

struct HgiTextureToBufferOp
{
    HgiTextureToBufferOp()
    : gpuSourceTexture()
    , sourceTexelOffset(GfVec3i(0))
    , mipLevel(0)
    , gpuDestinationBuffer()
    , destinationByteOffset(0)
    , byteSize(0)
    {}

    HgiTextureHandle gpuSourceTexture;
    GfVec3i sourceTexelOffset;
    uint32_t mipLevel;
    HgiBufferHandle gpuDestinationBuffer;
    size_t destinationByteOffset;
    size_t byteSize;
};

struct HgiBufferToTextureOp
{
    HgiBufferToTextureOp()
    : gpuSourceBuffer()
    , sourceByteOffset(0)
    , gpuDestinationTexture()
    , destinationTexelOffset(GfVec3i(0))
    , mipLevel(0)
    , byteSize(0)
    {}

    HgiBufferHandle gpuSourceBuffer;
    size_t sourceByteOffset;
    HgiTextureHandle gpuDestinationTexture;
    GfVec3i destinationTexelOffset;
    uint32_t mipLevel;
    size_t byteSize;
    
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif