udimTextureObject.h

//
// Copyright 2020 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_ST_UDIM_TEXTURE_OBJECT_H
#define PXR_IMAGING_HD_ST_UDIM_TEXTURE_OBJECT_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
 
#include "pxr/imaging/hdSt/textureObject.h"
 
#include "pxr/imaging/hgi/handle.h"
 
#include "pxr/base/gf/vec3i.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
enum HgiFormat : int;
using HgiTextureHandle = HgiHandle<class HgiTexture>;
 
HDST_API bool HdStIsSupportedUdimTexture(std::string const& imageFilePath);
 
class HdStUdimTextureObject final : public HdStTextureObject
{
public:
    HDST_API
    HdStUdimTextureObject(
        const HdStTextureIdentifier &textureId,
        HdSt_TextureObjectRegistry *textureObjectRegistry);
 
    HDST_API
    ~HdStUdimTextureObject() override;
 
    HgiTextureHandle const& GetTexelTexture() const { return _texelTexture; }
 
    HgiTextureHandle const& GetLayoutTexture() const { return _layoutTexture; }
 
    HDST_API
    bool IsValid() const override;
 
    HDST_API
    HdStTextureType GetTextureType() const override;
 
    HDST_API
    size_t GetCommittedSize() const override;
 
protected:
    HDST_API
    void _Load() override;
 
    HDST_API
    void _Commit() override;
 
private:
    std::vector<uint8_t> _textureData;
    std::vector<float> _layoutData;
    size_t _textureDataSize;
    size_t _layoutDataSize;
 
    GfVec3i _dimensions;
    size_t _tileCount;
    size_t _mipCount;
    HgiFormat _hgiFormat;
 
    HgiTextureHandle _texelTexture;
    HgiTextureHandle _layoutTexture;
 
    void _DestroyTextures();
};
 
template<>
struct HdSt_TypedTextureObjectHelper<HdStTextureType::Udim> {
    using type = HdStUdimTextureObject;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif