OpenDX/src/dxvk/dxvk_resource.h

#pragma once

#include "dxvk_include.h"

namespace dxvk {
  
  enum class DxvkAccess {
    Read    = 0,
    Write   = 1,
    None    = 2,
  };
  
  using DxvkAccessFlags = Flags<DxvkAccess>;
  
  /**
   * \brief DXVK resource
   * 
   * Keeps track of whether the resource is currently in use
   * by the GPU. As soon as a command that uses the resource
   * is recorded, it will be marked as 'in use'.
   */
  class DxvkResource : public RcObject {

  public:
    
    virtual ~DxvkResource();
    
    /**
     * \brief Checks whether resource is in use
     * 
     * Returns \c true if there are pending accesses to
     * the resource by the GPU matching the given access
     * type. Note that checking for reads will also return
     * \c true if the resource is being written to.
     * \param [in] access Access type to check for
     * \returns \c true if the resource is in use
     */
    bool isInUse(DxvkAccess access = DxvkAccess::Read) const {
      bool result = m_useCountW.load() != 0;
      if (access == DxvkAccess::Read)
        result |= m_useCountR.load() != 0;
      return result;
    }
    
    /**
     * \brief Acquires resource
     * 
     * Increments use count for the given access type.
     * \param Access Resource access type
     */
    void acquire(DxvkAccess access) {
      if (access != DxvkAccess::None) {
        (access == DxvkAccess::Read
          ? m_useCountR
          : m_useCountW) += 1;
      }
    }

    /**
     * \brief Releases resource
     * 
     * Decrements use count for the given access type.
     * \param Access Resource access type
     */
    void release(DxvkAccess access) {
      if (access != DxvkAccess::None) {
        (access == DxvkAccess::Read
          ? m_useCountR
          : m_useCountW) -= 1;
      }
    }

    /**
     * \brief Waits for resource to become unused
     *
     * Blocks calling thread until the GPU finishes
     * using the resource with the given access type.
     * \param [in] access Access type to check for
     */
    void waitIdle(DxvkAccess access = DxvkAccess::Read) const {
      sync::spin(50000, [this, access] {
        return !isInUse(access);
      });
    }
    
  private:
    
    std::atomic<uint32_t> m_useCountR = { 0u };
    std::atomic<uint32_t> m_useCountW = { 0u };

  };
  
}