blitCmdsOps.h

Go to the documentation of this file.

//
// 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
///
/// Describes the properties needed to copy texture data from GPU to CPU.
/// This copies one mip at a time.
///
/// It is the responsibility of the caller to:
///   - ensure the destination buffer is large enough to receive the data
///     (keep in mind the destinationByteOffset, mipLevel, numLayers, etc).
///   - ensure the source texture and destination buffer are valid at the time
///     the command is executed.
///
/// <ul>
/// <li>gpuSourceTexture:
///   The gpu texture to copy pixels from.</li>
/// <li>sourceTexelOffset:
///   The texel offset (width, height, depth) of where to start copying.
///   If the texture is a 2d_array the third element is the layer/slice.</li>
/// <li>mipLevel:
///   Mip level to copy from.</li>
/// <li>cpuDestinationBuffer:
///   The copy destination cpu buffer.</li>
/// <li>destinationByteOffset:
///   The byte offset in destination buffer where to start copying the data to.</li>
/// <li>destinationBufferByteSize:
///   Size of the destination buffer (in bytes)</li>
/// </ul>
///
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
///
/// Describes the properties needed to copy texture data from CPU to GPU.
/// This uploads one mip at a time.
///
/// It is the responsibility of the caller to:
///   - ensure the destination textures is large enough to receive the data.
///   - ensure the source buffer and destination texture are valid at the time
///     the command is executed.
///
/// <ul>
/// <li>cpuSourceBuffer:
///   Pointer to CPU source (ie. texels) to copy the data from.</li>
/// <li>bufferByteSize:
///   Byte size (length) of cpuSourceBuffer.</li>
/// <li>destinationTexelOffset:
///   The texel offset (width, height, depth) of where to upload the data.
///   If the texture is a 2d_array the third element is the layer/slice.</li>
/// <li>mipLevel:
///   Mip level to upload into.</li>
/// <li>gpuDestinationTexture:
///   The GPU texture to upload the data into.</li>
/// </ul>
///
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
///
/// Describes the properties needed to copy buffer data from GPU to GPU.
///
/// It is the responsibility of the caller to:
///   - ensure the destination buffer is large enough to receive the data
///     (keep in mind the destinationByteOffset).
///   - ensure the source buffer and destination buffer are valid at the time
///     the command is executed.
///
/// <ul>
/// <li>gpuSourceBuffer:
///   The gpu buffer to copy data from.</li>
/// <li>sourceByteOffset:
///   The byte offset in source buffer to start copying the data from.</li>
/// <li>byteSize:
///   Size of the data (in bytes) to copy</li>
/// <li>gpuDestinationBuffer:
///   The copy destination gpu buffer.</li>
/// <li>destinationByteOffset:
///   The byte offset in destination buffer where to start copying the data to.</li>
/// </ul>
///
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
///
/// Describes the properties needed to copy buffer data from CPU to GPU.
///
/// It is the responsibility of the caller to:
///   - ensure the destination buffer is large enough to receive the data.
///   - ensure the source buffer and destination buffer are valid at the time
///     the command is executed.
///
/// <ul>
/// <li>cpuSourceBuffer:
///   Pointer to CPU source to copy the data from.</li>
/// <li>sourceByteOffset:
///   The byte location in cpuSourceBuffer where copying starts.</li>
/// <li>gpuDestinationBuffer:
///   The GPU buffer to copy the data into.</li>
/// <li>destinationByteOffset:
///   The byte location in gpuDestinationBuffer where copying starts.</li>
/// <li>byteSize:
///   The size in bytes to copy.</li>
/// </ul>
///
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
///
/// Describes the properties needed to copy buffer data from GPU to CPU.
///
/// It is the responsibility of the caller to:
///   - ensure the destination buffer is large enough to receive the data
///     (keep in mind the destinationByteOffset).
///   - ensure the source buffer and destination buffer are valid at the time
///     the command is executed.
///
/// <ul>
/// <li>gpuSourceBuffer:
///   The gpu buffer to copy data from.</li>
/// <li>sourceByteOffset:
///   The byte offset in source buffer to start copying the data from.</li>
/// <li>byteSize:
///   Size of the data (in bytes) to copy</li>
/// <li>cpuDestinationBuffer:
///   The copy destination cpu buffer.</li>
/// <li>destinationByteOffset:
///   The byte offset in destination buffer where to start copying the data to.</li>
/// </ul>
///
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
///
/// Describes the properties needed to copy GPU texture data into a GPU buffer.
///
/// It is the responsibility of the caller to:
///   - ensure the destination buffer is large enough to receive the data
///     (keep in mind the destinationByteOffset).
///   - ensure the source texture and destination buffer are valid at the time
///     the command is executed.
///
/// <ul>
/// <li>gpuSourceTexture:
///   The gpu texture to copy pixels from.</li>
/// <li>mipLevel:
///   Mip level to copy from.</li>
/// <li>gpuDestinationBuffer:
///   The GPU buffer to copy the data into.</li>
/// <li>destinationByteOffset:
///   The byte offset in destination buffer where to start copying the data to.</li>
/// <li>byteSize:
///   Size of the data (in bytes) to copy</li>
/// </ul>
///
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
///
/// Describes the properties needed to copy GPU buffer data into a GPU texture.
///
/// It is the responsibility of the caller to:
///   - ensure the destination textures is large enough to receive the data.
///   - ensure the source buffer and destination texture are valid at the time
///     the command is executed.
///
/// <ul>
/// <li>gpuSourceBuffer:
///   The gpu buffer to copy data from.</li>
/// <li>sourceByteOffset:
///   The byte offset in source buffer to start copying the data from.</li>
/// <li>gpuDestinationTexture:
///   The GPU texture to upload the data into.</li>
/// <li>destinationTexelOffset:
///   The texel offset (width, height, depth) of where to upload the data.
///   If the texture is a 2d_array the third element is the layer/slice.</li>
/// <li>mipLevel:
///   Mip level to upload into.</li>
/// <li>byteSize:
///   Size of the data (in bytes) to copy</li>
/// </ul>
///
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