skia/public/mojom/bitmap.mojom

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

// This file contains structures used to represent SkBitmaps in Mojo.
module skia.mojom;

import "mojo/public/mojom/base/big_buffer.mojom";
import "skia/public/mojom/image_info.mojom";

[Stable]
struct Bitmap {
  ImageInfo image_info;
  uint64 row_bytes;
  mojo_base.mojom.BigBuffer pixel_data;
};

// Similar to above, but the generated bindings avoid copying pixel data on the
// receiving side of an IPC message. That can be a valuable optimization for
// large bitmaps. However, this is unsafe for some applications as it leaves
// open the possibility for the sender to continue to modify the pixel data,
// which could lead to TOCTOU issues. Use this type *only* when the sender is
// trusted.
//
// NOTE: It is important that the fields of this struct exactly match the
// fields of the Bitmap struct. This enables stable interfaces to freely
// migrate between these two types in a compatible fashion.
[Stable]
struct UnsafeBitmap {
  ImageInfo image_info;
  uint64 row_bytes;
  mojo_base.mojom.BigBuffer pixel_data;
};

// NOTE: This should only be used when an SkBitmap MUST be serialized as raw
// bytes (i.e. it's not OK for shared memory to be used, as above).
struct InlineBitmap {
  ImageInfo image_info;
  uint64 row_bytes;
  array<uint8> pixel_data;
};