bin/ui/root_presenter/displays/display_metrics.h

// Copyright 2017 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef GARNET_BIN_UI_ROOT_PRESENTER_DISPLAYS_DISPLAY_METRICS_H_
#define GARNET_BIN_UI_ROOT_PRESENTER_DISPLAYS_DISPLAY_METRICS_H_

#include <cstdint>

#include "lib/fxl/logging.h"

namespace root_presenter {

// Describes the measurements and scale factors used to layout and render
// user interfaces and other graphical content on a particular a display.
class DisplayMetrics {
 public:
  constexpr DisplayMetrics() {}

  constexpr DisplayMetrics(uint32_t width_in_px, uint32_t height_in_px,
                           float x_scale_in_px_per_pp,
                           float y_scale_in_px_per_pp,
                           float density_in_pp_per_mm)
      : width_in_px_(width_in_px),
        height_in_px_(height_in_px),
        x_scale_in_px_per_pp_(x_scale_in_px_per_pp),
        y_scale_in_px_per_pp_(y_scale_in_px_per_pp),
        density_in_pp_per_mm_(density_in_pp_per_mm) {
    FXL_DCHECK(width_in_px_ > 0u);
    FXL_DCHECK(height_in_px_ > 0u);
    FXL_DCHECK(x_scale_in_px_per_pp_ > 0.f);
    FXL_DCHECK(y_scale_in_px_per_pp_ > 0.f);
    FXL_DCHECK(density_in_pp_per_mm_ >= 0.f);
  }

  bool operator==(const DisplayMetrics& other) const {
    return this->width_in_px_ == other.width_in_px_ &&
           this->height_in_px_ == other.height_in_px_ &&
           this->x_scale_in_px_per_pp_ == other.x_scale_in_px_per_pp_ &&
           this->y_scale_in_px_per_pp_ == other.y_scale_in_px_per_pp_ &&
           this->density_in_pp_per_mm_ == other.density_in_pp_per_mm_;
  }

  // PIXEL METRICS

  // The width of the visible content area in pixels.
  uint32_t width_in_px() const { return width_in_px_; }

  // The height of the visible content area in pixels.
  uint32_t height_in_px() const { return height_in_px_; }

  // PHYSICAL METRICS

  // The physical width of the visible content area in millimeters.
  // Value is 0.0 if unknown.
  float width_in_mm() const { return width_in_pp() * density_in_mm_per_pp(); }

  // The physical height of the visible content area in millimeters.
  // Value is 0.0 if unknown.
  float height_in_mm() const { return height_in_pp() * density_in_mm_per_pp(); }

  // GRID METRICS

  // The width of the visible content area in pips.
  float width_in_pp() const { return width_in_px_ / x_scale_in_px_per_pp_; }

  // The height of the visible content area in pips.
  float height_in_pp() const { return height_in_px_ / y_scale_in_px_per_pp_; }

  // The pip scale factor in pixels per pip in X dimension.
  float x_scale_in_px_per_pp() const { return x_scale_in_px_per_pp_; }

  // The pip scale factor in pixels per pip in Y dimension.
  float y_scale_in_px_per_pp() const { return y_scale_in_px_per_pp_; }

  // The pip scale factor in pips per pixel in X dimension.
  float x_scale_in_pp_per_px() const { return 1.f / x_scale_in_px_per_pp_; }

  // The pip scale factor in pips per pixel in Y dimension.
  float y_scale_in_pp_per_px() const { return 1.f / y_scale_in_px_per_pp_; }

  // The pip density in pips per millimeter.
  // Value is 0.0 if unknown.
  float density_in_pp_per_mm() const { return density_in_pp_per_mm_; }

  // The pip density in millimeters per pip.
  // Value is 0.0 if unknown.
  float density_in_mm_per_pp() const {
    return density_in_pp_per_mm_ != 0.f ? 1.f / density_in_pp_per_mm_ : 0.f;
  }

 private:
  uint32_t width_in_px_ = 0;
  uint32_t height_in_px_ = 0;
  float x_scale_in_px_per_pp_ = 0.f;
  float y_scale_in_px_per_pp_ = 0.f;
  float density_in_pp_per_mm_ = 0.f;
};

}  // namespace root_presenter

#endif  // GARNET_BIN_UI_ROOT_PRESENTER_DISPLAYS_DISPLAY_METRICS_H_