gpu_memory_buffer.h revision f8ee788a64d60abd8f2d742a5fdedde054ecd910 
1// Copyright 2013 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef UI_GFX_GPU_MEMORY_BUFFER_H_
6#define UI_GFX_GPU_MEMORY_BUFFER_H_
7
8#include "base/memory/shared_memory.h"
9#include "build/build_config.h"
10#include "ui/gfx/gfx_export.h"
11
12#if defined(OS_ANDROID)
13#include <third_party/khronos/EGL/egl.h>
14#endif
15
16namespace gfx {
17
18enum GpuMemoryBufferType {
19  EMPTY_BUFFER,
20  SHARED_MEMORY_BUFFER,
21  IO_SURFACE_BUFFER,
22  ANDROID_NATIVE_BUFFER,
23  SURFACE_TEXTURE_BUFFER,
24  GPU_MEMORY_BUFFER_TYPE_LAST = SURFACE_TEXTURE_BUFFER
25};
26
27// TODO(alexst): Merge this with GpuMemoryBufferId as part of switchover to
28// the new API for GpuMemoryBuffer allocation when it's done.
29#if defined(OS_ANDROID)
30struct SurfaceTextureId {
31  SurfaceTextureId() : primary_id(0), secondary_id(0) {}
32  SurfaceTextureId(int32 primary_id, int32 secondary_id)
33      : primary_id(primary_id), secondary_id(secondary_id) {}
34  int32 primary_id;
35  int32 secondary_id;
36};
37#endif
38
39struct GpuMemoryBufferId {
40  GpuMemoryBufferId() : primary_id(0), secondary_id(0) {}
41  GpuMemoryBufferId(int32 primary_id, int32 secondary_id)
42      : primary_id(primary_id), secondary_id(secondary_id) {}
43  int32 primary_id;
44  int32 secondary_id;
45};
46
47struct GFX_EXPORT GpuMemoryBufferHandle {
48  GpuMemoryBufferHandle();
49  bool is_null() const { return type == EMPTY_BUFFER; }
50  GpuMemoryBufferType type;
51  base::SharedMemoryHandle handle;
52  GpuMemoryBufferId global_id;
53#if defined(OS_MACOSX)
54  uint32 io_surface_id;
55#endif
56#if defined(OS_ANDROID)
57  EGLClientBuffer native_buffer;
58  SurfaceTextureId surface_texture_id;
59#endif
60};
61
62// This interface typically correspond to a type of shared memory that is also
63// shared with the GPU. A GPU memory buffer can be written to directly by
64// regular CPU code, but can also be read by the GPU.
65class GFX_EXPORT GpuMemoryBuffer {
66 public:
67  GpuMemoryBuffer();
68  virtual ~GpuMemoryBuffer();
69
70  // Maps the buffer into the client's address space so it can be written to by
71  // the CPU. This call may block, for instance if the GPU needs to finish
72  // accessing the buffer or if CPU caches need to be synchronized. Returns NULL
73  // on failure.
74  virtual void* Map() = 0;
75
76  // Unmaps the buffer. It's illegal to use the pointer returned by Map() after
77  // this has been called.
78  virtual void Unmap() = 0;
79
80  // Returns true iff the buffer is mapped.
81  virtual bool IsMapped() const = 0;
82
83  // Returns the stride in bytes for the buffer.
84  virtual uint32 GetStride() const = 0;
85
86  // Returns a platform specific handle for this buffer.
87  virtual GpuMemoryBufferHandle GetHandle() const = 0;
88};
89
90}  // namespace gfx
91
92#endif  // UI_GFX_GPU_MEMORY_BUFFER_H_
93