gecko-dev/gfx/ipc/CompositorOptions.h
Jean-Yves Avenard 11ac9e9cf8 Bug 1540581 - P6. Tidy some C++ declarations in gfx/. r=gerald,jrmuizel
* Remove redundant virtual keywords
* Mark all destructors of inheriting classes as virtual for clarity
* Mark all classes without virtual destructor as final (exposed errors)
* Make destructor virtual where it needed to be (some were missing)
* Replace empty ({}) code declaration in header with = default
* Remove virtual unused methods

I probably missed some, it quickly became a rabbit hole.

Differential Revision: https://phabricator.services.mozilla.com/D26060

--HG--
extra : moz-landing-system : lando
2019-04-11 12:36:51 +00:00

78 lines
2.6 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 _include_mozilla_gfx_ipc_CompositorOptions_h_
#define _include_mozilla_gfx_ipc_CompositorOptions_h_
namespace IPC {
template <typename>
struct ParamTraits;
} // namespace IPC
namespace mozilla {
namespace layers {
/**
* This class holds options that are "per compositor" - that is, these options
* affect a particular CompositorBridgeParent and all the content that it
* renders.
*
* This class is intended to be created by a platform widget (but NOT
* PuppetWidget) and passed to the graphics code during initialization of the
* top level compositor associated with that widget. The options are immutable
* after creation. The CompositorBridgeParent holds the canonical version of
* the options, but they may be accessed by other parts of the code as needed,
* and are accessible to content processes over PCompositorBridge as well.
*/
class CompositorOptions {
public:
// This constructor needed for IPDL purposes, don't use it anywhere else.
CompositorOptions()
: mUseAPZ(false),
mUseWebRender(false),
mUseAdvancedLayers(false),
mInitiallyPaused(false) {}
CompositorOptions(bool aUseAPZ, bool aUseWebRender)
: mUseAPZ(aUseAPZ),
mUseWebRender(aUseWebRender),
mUseAdvancedLayers(false),
mInitiallyPaused(false) {}
bool UseAPZ() const { return mUseAPZ; }
bool UseWebRender() const { return mUseWebRender; }
bool UseAdvancedLayers() const { return mUseAdvancedLayers; }
bool InitiallyPaused() const { return mInitiallyPaused; }
void SetUseAdvancedLayers(bool aUseAdvancedLayers) {
mUseAdvancedLayers = aUseAdvancedLayers;
}
void SetInitiallyPaused(bool aPauseAtStartup) {
mInitiallyPaused = aPauseAtStartup;
}
bool operator==(const CompositorOptions& aOther) const {
return mUseAPZ == aOther.mUseAPZ && mUseWebRender == aOther.mUseWebRender &&
mUseAdvancedLayers == aOther.mUseAdvancedLayers;
}
friend struct IPC::ParamTraits<CompositorOptions>;
private:
bool mUseAPZ;
bool mUseWebRender;
bool mUseAdvancedLayers;
bool mInitiallyPaused;
// Make sure to add new fields to the ParamTraits implementation
// in LayersMessageUtils.h
};
} // namespace layers
} // namespace mozilla
#endif // _include_mozilla_gfx_ipc_CompositorOptions_h_