src/ui/scenic/lib/view_tree/tests/utils.h

// Copyright 2021 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_UI_SCENIC_LIB_VIEW_TREE_TESTS_UTILS_H_
#define SRC_UI_SCENIC_LIB_VIEW_TREE_TESTS_UTILS_H_

#include "src/ui/scenic/lib/view_tree/snapshot_types.h"

namespace view_tree {
enum : zx_koid_t { kNodeA = 1, kNodeB, kNodeC, kNodeD };

// Creates a snapshot with the following two-node topology:
//     A
//     |
//     B
std::shared_ptr<view_tree::Snapshot> TwoNodeSnapshot();

// Creates a snapshot with the following three-node topology:
//     A
//     |
//     B
//     |
//     C
std::shared_ptr<const view_tree::Snapshot> ThreeNodeSnapshot();

// Creates a snapshot with the following four-node topology:
//      A
//    /   \
//   B     C
//   |
//   D
std::shared_ptr<const view_tree::Snapshot> FourNodeSnapshot();

// Creates a snapshot having a view tree with depth 1 and |total_nodes| - 1 leaf nodes. Eg:- The
// view tree will have the following topology when |total_nodes| is 5:
//      A
//   / / \ \
//  B  C  D  E
// Note: |total_nodes| cannot be 0.
std::shared_ptr<const view_tree::Snapshot> SingleDepthViewTreeSnapshot(
    uint64_t total_nodes, std::optional<bool> gfx_is_rendering);

}  // namespace view_tree

#endif  // SRC_UI_SCENIC_LIB_VIEW_TREE_TESTS_UTILS_H_