donner::svg::compositor::CompositorController::PromoteResult Struct Reference

Result of requesting an editor-facing compositor presentation plan. More...

#include "donner/svg/compositor/CompositorController.h"

Public Types
enum class	Code : uint8_t {   PromotedLayer ,   FullCanvasPreviewRequired ,   InvalidEntity ,   LayerLimit ,   MemoryLimit ,   DescendantPromoted }

Public Member Functions
bool	promotedLayer () const
bool	fullCanvasPreviewRequired () const
	operator bool () const

Public Attributes
Code	code = Code::PromotedLayer
	Result code for this promotion request.

Static Public Attributes
static constexpr Code	PromotedLayer = Code::PromotedLayer
static constexpr Code	FullCanvasPreviewRequired = Code::FullCanvasPreviewRequired
static constexpr Code	InvalidEntity = Code::InvalidEntity
static constexpr Code	LayerLimit = Code::LayerLimit
static constexpr Code	MemoryLimit = Code::MemoryLimit
static constexpr Code	DescendantPromoted = Code::DescendantPromoted

Friends
bool	operator== (PromoteResult result, Code code)
bool	operator== (Code code, PromoteResult result)

Detailed Description

Result of requesting an editor-facing compositor presentation plan.

Member Enumeration Documentation

Code

enum class donner::svg::compositor::CompositorController::PromoteResult::Code : uint8_t

strong

Enumerator
PromotedLayer	The requested entity owns a promoted compositor layer.
FullCanvasPreviewRequired	The request is valid but must be presented as a full-canvas preview.
InvalidEntity	The requested entity is not valid in the document registry.
LayerLimit	The compositor cannot add another layer without exceeding the layer limit.
MemoryLimit	The compositor cannot add another layer without exceeding the memory budget.
DescendantPromoted	A descendant is already promoted, so this entity was not promoted.

---

The documentation for this struct was generated from the following file:

• donner/svg/compositor/CompositorController.h