/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef gfx_SharedDIB_h__
#define gfx_SharedDIB_h__

#include "base/shared_memory.h"
#include "nscore.h"

namespace mozilla {
namespace gfx {

class SharedDIB {
 public:
  typedef base::SharedMemoryHandle Handle;

  static const uint32_t kBytesPerPixel = 4;

 public:
  SharedDIB();
  ~SharedDIB();

  // Create and allocate a new shared dib.
  nsresult Create(uint32_t aSize);

  // Destroy or release resources associated with this dib.
  nsresult Close();

  // Returns true if this object contains a valid dib.
  bool IsValid();

  // Wrap a new shared dib around allocated shared memory. Note aHandle must
  // point to a memory section large enough to hold a dib of size aSize,
  // otherwise this will fail.
  nsresult Attach(Handle aHandle, uint32_t aSize);

  // Returns a SharedMemoryHandle suitable for sharing with another process.
  nsresult ShareToProcess(base::ProcessId aTargetPid, Handle* aNewHandle);

 protected:
  base::SharedMemory* mShMem;
};

}  // namespace gfx
}  // namespace mozilla

#endif