Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorScrollEngine::ScrollBlueprintProgress Struct Reference

How far a screen has worked through its context template's seed blueprint. More...

#include <PhosphorScrollEngine/ScrollTypes.h>

Public Member Functions

bool operator== (const ScrollBlueprintProgress &) const =default

Public Attributes

int total = 0
int used = 0

Detailed Description

How far a screen has worked through its context template's seed blueprint.

The blueprint describes the columns a strip STARTS with, one entry per column, and an entry is spent once a column has taken it. This is that progress made inspectable: total is how many starting columns the blueprint declares (after the engine's own kMaxTemplateEntries cap, so it counts entries that can actually be consumed rather than what an embedder supplied), and used is how many the screen has already taken.

used == total means the blueprint is exhausted and further columns open at the template's ordinary defaults. Both are zero on a screen with no blueprint, which is also what a screen that is not scrolling reports.

Member Function Documentation

◆ operator==()

bool PhosphorScrollEngine::ScrollBlueprintProgress::operator== ( const ScrollBlueprintProgress & ) const
default

Member Data Documentation

◆ total

int PhosphorScrollEngine::ScrollBlueprintProgress::total = 0

◆ used

int PhosphorScrollEngine::ScrollBlueprintProgress::used = 0

The documentation for this struct was generated from the following file:
  • phosphor-scroll-engine/include/PhosphorScrollEngine/ScrollTypes.h