src/graphics/display/lib/api-types-cpp/image-tiling-type.h

// Copyright 2024 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 SRC_GRAPHICS_DISPLAY_LIB_API_TYPES_CPP_IMAGE_TILING_TYPE_H_
#define SRC_GRAPHICS_DISPLAY_LIB_API_TYPES_CPP_IMAGE_TILING_TYPE_H_

#include <fidl/fuchsia.hardware.display.types/cpp/wire.h>
#include <fuchsia/hardware/display/controller/c/banjo.h>
#include <zircon/assert.h>

namespace display {

// Equivalent to the FIDL type [`fuchsia.hardware.display.types/ImageTilingTypeIdValue`].
class ImageTilingType {
 public:
  explicit constexpr ImageTilingType(
      fuchsia_hardware_display_types::wire::ImageTilingTypeIdValue fidl_tiling_type_id_value)
      : tiling_type_id_(fidl_tiling_type_id_value) {}

  ImageTilingType(const ImageTilingType&) = default;
  ImageTilingType& operator=(const ImageTilingType&) = default;
  ~ImageTilingType() = default;

  constexpr fuchsia_hardware_display_types::wire::ImageTilingTypeIdValue ToFidl() const;
  constexpr image_tiling_type_t ToBanjo() const;

  // Raw numerical value.
  //
  // This is intended to be used for developer-facing output, such as logging
  // and Inspect. The values are not guaranteed to have any stable semantics.
  constexpr uint32_t ValueForLogging() const;

 private:
  friend constexpr bool operator==(const ImageTilingType& lhs, const ImageTilingType& rhs);
  friend constexpr bool operator!=(const ImageTilingType& lhs, const ImageTilingType& rhs);

  fuchsia_hardware_display_types::wire::ImageTilingTypeIdValue tiling_type_id_;
};

// See [`fuchsia.hardware.display.types/IMAGE_TILING_TYPE_LINEAR`].
constexpr ImageTilingType kImageTilingTypeLinear{
    fuchsia_hardware_display_types::wire::kImageTilingTypeLinear};

// See [`fuchsia.hardware.display.types/IMAGE_TILING_TYPE_CAPTURE`].
constexpr ImageTilingType kImageTilingTypeCapture{
    fuchsia_hardware_display_types::wire::kImageTilingTypeCapture};

constexpr bool operator==(const ImageTilingType& lhs, const ImageTilingType& rhs) {
  return lhs.tiling_type_id_ == rhs.tiling_type_id_;
}

constexpr bool operator!=(const ImageTilingType& lhs, const ImageTilingType& rhs) {
  return !(lhs == rhs);
}

constexpr fuchsia_hardware_display_types::wire::ImageTilingTypeIdValue ImageTilingType::ToFidl()
    const {
  return tiling_type_id_;
}

constexpr image_tiling_type_t ImageTilingType::ToBanjo() const {
  return static_cast<image_tiling_type_t>(tiling_type_id_);
}

constexpr uint32_t ImageTilingType::ValueForLogging() const {
  return static_cast<uint32_t>(tiling_type_id_);
}

}  // namespace display

#endif  // SRC_GRAPHICS_DISPLAY_LIB_API_TYPES_CPP_IMAGE_TILING_TYPE_H_