Class NativeHandle

Source/Falcor/Core/API/NativeHandle.h:73–99

Represents a native graphics API handle (e.g. D3D12 or Vulkan). Native handles are expected to fit into 64 bits. Type information and conversion from/to native handles is done using type traits from NativeHandleTraits.h which needs to be included when creating and accessing NativeHandle. This separation is done so we don't expose the heavy D3D12/Vulkan headers everywhere.

/// This separation is done so we don't expose the heavy D3D12/Vulkan
/// headers everywhere.
class NativeHandle
{
public:
    NativeHandle() = default;

    template<typename T>
    explicit NativeHandle(T native)
    {
        mType = NativeHandleTrait<T>::type;
        mValue = NativeHandleTrait<T>::pack(native);
    }

    NativeHandleType getType() const { return mType; }

    bool isValid() const { return mType != NativeHandleType::Unknown; }

    template<typename T>
    T as() const
    {
        FALCOR_ASSERT(mType == NativeHandleTrait<T>::type);
        return NativeHandleTrait<T>::unpack(mValue);
    }

private:
    NativeHandleType mType{NativeHandleType::Unknown};
    uint64_t mValue{0};
};

} // namespace Falcor