src/ui/scenic/lib/gfx/resources/image_pipe_base.h

// Copyright 2019 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_GFX_RESOURCES_IMAGE_PIPE_BASE_H_
#define SRC_UI_SCENIC_LIB_GFX_RESOURCES_IMAGE_PIPE_BASE_H_

#include "src/ui/scenic/lib/gfx/engine/session.h"
#include "src/ui/scenic/lib/gfx/resources/image_base.h"
#include "src/ui/scenic/lib/gfx/resources/resource.h"

namespace escher {
class ReleaseFenceSignaller;
}

namespace scenic_impl::gfx {

struct ImagePipeUpdateResults {
  bool image_updated;
};

// Abstract superclass for ImagePipe and ImagePipe2.
// TODO(35636): This class is to be DEPRECATED in favor of ImagePipe2.
class ImagePipeBase : public ImageBase {
 public:
  // Call telling the ImagePipe to update up to the Present call matching |present_id|.
  // Called before rendering a frame using this ImagePipe. Returns
  // |image_updated| as true if the current Image changed since the last time
  // Update() was called, and false otherwise.
  virtual ImagePipeUpdateResults Update(scheduling::PresentId present_id) = 0;

  // Resource implementation
  void Accept(class ResourceVisitor* visitor) override;

 protected:
  ImagePipeBase(Session* session, ResourceId id, const ResourceTypeInfo& type_info);
};

}  // namespace scenic_impl::gfx

#endif  // SRC_UI_SCENIC_LIB_GFX_RESOURCES_IMAGE_PIPE_BASE_H_