67 lines
1.9 KiB
C++
67 lines
1.9 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef GFX_TRANSACTION_ID_ALLOCATOR_H
|
|
#define GFX_TRANSACTION_ID_ALLOCATOR_H
|
|
|
|
#include "nsISupportsImpl.h"
|
|
#include "mozilla/TimeStamp.h"
|
|
|
|
namespace mozilla {
|
|
namespace layers {
|
|
|
|
class TransactionIdAllocator {
|
|
protected:
|
|
virtual ~TransactionIdAllocator() {}
|
|
|
|
public:
|
|
NS_INLINE_DECL_REFCOUNTING(TransactionIdAllocator)
|
|
|
|
/**
|
|
* Allocate a unique id number for the current refresh tick, can
|
|
* only be called while IsInRefresh().
|
|
*
|
|
* If too many id's are allocated without being returned then
|
|
* the refresh driver will suspend until they catch up.
|
|
*/
|
|
virtual uint64_t GetTransactionId() = 0;
|
|
|
|
/**
|
|
* Return the transaction id that for the last non-revoked transaction.
|
|
* This allows the caller to tell whether a composite was triggered by
|
|
* a paint that occurred after a call to TransactionId().
|
|
*/
|
|
virtual uint64_t LastTransactionId() const = 0;
|
|
|
|
/**
|
|
* Notify that all work (including asynchronous composites)
|
|
* for a given transaction id has been completed.
|
|
*
|
|
* If the refresh driver has been suspended because
|
|
* of having too many outstanding id's, then this may
|
|
* resume it.
|
|
*/
|
|
virtual void NotifyTransactionCompleted(uint64_t aTransactionId) = 0;
|
|
|
|
/**
|
|
* Revoke a transaction id that isn't needed to track
|
|
* completion of asynchronous work. This is similar
|
|
* to NotifyTransactionCompleted except avoids
|
|
* return ordering issues.
|
|
*/
|
|
virtual void RevokeTransactionId(uint64_t aTransactionId) = 0;
|
|
|
|
/**
|
|
* Get the start time of the current refresh tick.
|
|
*/
|
|
virtual mozilla::TimeStamp GetTransactionStart() = 0;
|
|
};
|
|
|
|
} // namespace layers
|
|
} // namespace mozilla
|
|
|
|
|
|
#endif /* GFX_TRANSACTION_ID_ALLOCATOR_H */
|