lib/ui/scenic/resources/host_image.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_LIB_UI_SCENIC_RESOURCES_HOST_IMAGE_H_
#define GARNET_LIB_UI_SCENIC_RESOURCES_HOST_IMAGE_H_

#include "garnet/lib/ui/scenic/resources/host_memory.h"
#include "garnet/lib/ui/scenic/resources/image.h"
#include "garnet/lib/ui/scenic/resources/memory.h"
#include "garnet/lib/ui/scenic/resources/resource.h"
#include "lib/escher/vk/image.h"

namespace scene_manager {

class HostImage;
using HostImagePtr = fxl::RefPtr<Image>;
using ImgConvertFunc = fbl::Function<void(void*, void*, uint32_t, uint32_t)>;

// An Image whose contents come from host-accessible memory.
class HostImage : public Image {
 public:
  static const ResourceTypeInfo kTypeInfo;

  // Create Image given a HostMemoryPtr, scenic::ImageInfoPtr, and
  // memory_offset.
  //
  // |session| is the Session that this image can be referenced from.
  // |id| is the ID of the resource.
  // |memory| is the memory that is associated with this image.
  // |image_info| specifies size, format, and other properties.
  // |memory_offset| specifies the offset into |memory| where the image is
  // stored.
  // |error_reporter| is used to log any errors so they can be seen by
  // the caller.
  //
  // Returns the created Image, or nullptr if there was an error.
  static ImagePtr New(Session* session,
                      scenic::ResourceId id,
                      HostMemoryPtr memory,
                      const scenic::ImageInfoPtr& host_image_info,
                      uint64_t memory_offset,
                      mz::ErrorReporter* error_reporter);

  static ImagePtr NewForTesting(Session* session,
                                scenic::ResourceId id,
                                escher::ResourceManager* image_owner,
                                HostMemoryPtr host_memory);

  void Accept(class ResourceVisitor* visitor) override;

  // Re-upload host memory contents to GPU memory. Returns true if contents were
  // updated.
  bool UpdatePixels() override;

 private:
  // Create an Image object from a escher::Image.
  // |session| is the Session that this image can be referenced from.
  // |id| is the ID assigned to the resource.
  // |memory| is the host memory that is associated with this image.
  // |gpu_image| is the escher::Image that is being wrapped.
  // |host_memory_offset| specifies the offset into |memory| where the image is
  // stored.
  HostImage(Session* session,
            scenic::ResourceId id,
            HostMemoryPtr memory,
            escher::ImagePtr gpu_image,
            uint64_t host_memory_offset,
            scenic::ImageInfo host_image_format);

  HostMemoryPtr memory_;
  // The offset into |memory_| where the image is stored, in bytes.
  uint64_t memory_offset_;
  // The format of the image stored in host memory
  scenic::ImageInfo host_image_format_;
  ImgConvertFunc image_conversion_function_ = nullptr;
};

}  // namespace scene_manager

#endif  // GARNET_LIB_UI_SCENIC_RESOURCES_HOST_IMAGE_H_