textureIdentifier.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_TEXTURE_IDENTIFIER_H
#define PXR_IMAGING_HD_ST_TEXTURE_IDENTIFIER_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
 
#include "pxr/base/tf/token.h"
#include "pxr/base/vt/value.h"
 
#include <memory>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdStSubtextureIdentifier;
 
class HdStTextureIdentifier final
{
public:
    using ID = size_t;
 
    HDST_API
    HdStTextureIdentifier();
 
    HDST_API
    explicit HdStTextureIdentifier(
        const TfToken &filePath,
        const VtValue &fallback = VtValue(),
        bool defaultToFallback = false);
 
    HDST_API
    HdStTextureIdentifier(
        const TfToken &filePath,
        std::unique_ptr<const HdStSubtextureIdentifier> &&subtextureId,
        const VtValue &fallback = VtValue(),
        bool defaultToFallback = false);
 
    HDST_API
    HdStTextureIdentifier(const HdStTextureIdentifier &textureId);
 
    HDST_API
    HdStTextureIdentifier &operator=(HdStTextureIdentifier &&textureId);
 
    HDST_API
    HdStTextureIdentifier &operator=(const HdStTextureIdentifier &textureId);
 
    HDST_API
    ~HdStTextureIdentifier();
 
    const TfToken &GetFilePath() const {
        return _filePath;
    }
 
    const VtValue &GetFallback() const {
        return _fallback;
    }
 
    bool ShouldDefaultToFallback() const {
        return _defaultToFallback;
    }
    
    const HdStSubtextureIdentifier * GetSubtextureIdentifier() const {
        return _subtextureId.get();
    }
 
    HDST_API
    bool operator==(const HdStTextureIdentifier &other) const;
    HDST_API
    bool operator!=(const HdStTextureIdentifier &other) const;
 
private:
    TfToken _filePath;
    VtValue _fallback;
    bool _defaultToFallback = false;
    std::unique_ptr<const HdStSubtextureIdentifier> _subtextureId;
};
 
HDST_API
size_t hash_value(const HdStTextureIdentifier &);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif