sampler.h

//
// Copyright 2020 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HGI_SAMPLER_H
#define PXR_IMAGING_HGI_SAMPLER_H

#include "pxr/pxr.h"

#include "pxr/base/tf/envSetting.h"

#include "pxr/imaging/hgi/api.h"
#include "pxr/imaging/hgi/enums.h"
#include "pxr/imaging/hgi/handle.h"
#include "pxr/imaging/hgi/types.h"

#include <string>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

HGI_API
extern TfEnvSetting<int> HGI_MAX_ANISOTROPY;

struct HgiSamplerDesc
{
    HgiSamplerDesc()
        : magFilter(HgiSamplerFilterNearest)
        , minFilter(HgiSamplerFilterNearest)
        , mipFilter(HgiMipFilterNotMipmapped)
        , addressModeU(HgiSamplerAddressModeClampToEdge)
        , addressModeV(HgiSamplerAddressModeClampToEdge)
        , addressModeW(HgiSamplerAddressModeClampToEdge)
        , borderColor(HgiBorderColorTransparentBlack)
        , enableCompare(false)
        , compareFunction(HgiCompareFunctionNever)
        , maxAnisotropy(16)
    {}

    std::string debugName;
    HgiSamplerFilter magFilter;
    HgiSamplerFilter minFilter;
    HgiMipFilter mipFilter;
    HgiSamplerAddressMode addressModeU;
    HgiSamplerAddressMode addressModeV;
    HgiSamplerAddressMode addressModeW;
    HgiBorderColor borderColor;
    bool enableCompare;
    HgiCompareFunction compareFunction;
    uint32_t maxAnisotropy;
};

HGI_API
bool operator==(
    const HgiSamplerDesc& lhs,
    const HgiSamplerDesc& rhs);

HGI_API
bool operator!=(
    const HgiSamplerDesc& lhs,
    const HgiSamplerDesc& rhs);


class HgiSampler
{
public:
    HGI_API
    virtual ~HgiSampler();

    HGI_API
    HgiSamplerDesc const& GetDescriptor() const;

    HGI_API
    virtual uint64_t GetRawResource() const = 0;

protected:
    HGI_API
    HgiSampler(HgiSamplerDesc const& desc);

    HgiSamplerDesc _descriptor;

private:
    HgiSampler() = delete;
    HgiSampler & operator=(const HgiSampler&) = delete;
    HgiSampler(const HgiSampler&) = delete;
};

using HgiSamplerHandle = HgiHandle<HgiSampler>;
using HgiSamplerHandleVector = std::vector<HgiSamplerHandle>;


PXR_NAMESPACE_CLOSE_SCOPE

#endif