blob: 1234dc2f27256662501e83c9fde40e79faff2b63 [file] [log] [blame]
// Copyright 2013 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.
#ifndef UI_GFX_GPU_MEMORY_BUFFER_H_
#define UI_GFX_GPU_MEMORY_BUFFER_H_
#include "base/memory/shared_memory.h"
#include "base/trace_event/memory_dump_manager.h"
#include "build/build_config.h"
#include "ui/gfx/buffer_types.h"
#include "ui/gfx/generic_shared_memory_id.h"
#include "ui/gfx/gfx_export.h"
extern "C" typedef struct _ClientBuffer* ClientBuffer;
namespace gfx {
enum GpuMemoryBufferType {
EMPTY_BUFFER,
SHARED_MEMORY_BUFFER,
IO_SURFACE_BUFFER,
SURFACE_TEXTURE_BUFFER,
OZONE_NATIVE_PIXMAP,
GPU_MEMORY_BUFFER_TYPE_LAST = OZONE_NATIVE_PIXMAP
};
using GpuMemoryBufferId = gfx::GenericSharedMemoryId;
struct GFX_EXPORT GpuMemoryBufferHandle {
GpuMemoryBufferHandle();
bool is_null() const { return type == EMPTY_BUFFER; }
GpuMemoryBufferType type;
GpuMemoryBufferId id;
base::SharedMemoryHandle handle;
};
base::trace_event::MemoryAllocatorDumpGuid GFX_EXPORT
GetGpuMemoryBufferGUIDForTracing(uint64 tracing_process_id,
GpuMemoryBufferId buffer_id);
// This interface typically correspond to a type of shared memory that is also
// shared with the GPU. A GPU memory buffer can be written to directly by
// regular CPU code, but can also be read by the GPU.
class GFX_EXPORT GpuMemoryBuffer {
public:
virtual ~GpuMemoryBuffer() {}
// Maps each plane of the buffer into the client's address space so it can be
// written to by the CPU. A pointer to plane K is stored at index K-1 of the
// |data| array. This call may block, for instance if the GPU needs to finish
// accessing the buffer or if CPU caches need to be synchronized. Returns
// false on failure.
virtual bool Map(void** data) = 0;
// Unmaps the buffer. It's illegal to use the pointer returned by Map() after
// this has been called.
virtual void Unmap() = 0;
// Returns true iff the buffer is mapped.
virtual bool IsMapped() const = 0;
// Returns the format for the buffer.
virtual BufferFormat GetFormat() const = 0;
// Fills the stride in bytes for each plane of the buffer. The stride of
// plane K is stored at index K-1 of the |stride| array.
virtual void GetStride(int* stride) const = 0;
// Returns a unique identifier associated with buffer.
virtual GpuMemoryBufferId GetId() const = 0;
// Returns a platform specific handle for this buffer.
virtual GpuMemoryBufferHandle GetHandle() const = 0;
// Type-checking downcast routine.
virtual ClientBuffer AsClientBuffer() = 0;
};
} // namespace gfx
#endif // UI_GFX_GPU_MEMORY_BUFFER_H_