[go: nahoru, domu]
Google Git
Sign in
android / platform / external / chromium_org / third_party / skia / src / a97ef5e8a2b07b735120d041de8e4612dfe59185 / . / gpu / GrGeometryBuffer.h
blob: 3bb7118fafc9c5f3c277d4c53089e3ecd764c901 [file] [log] [blame]
bsalomon@google.com3f30e3a2011-10-12 19:53:16 +0000[diff] [blame]1
2/*
3 * Copyright 2011 Google Inc.
4 *
5 * Use of this source code is governed by a BSD-style license that can be
6 * found in the LICENSE file.
7 */
8
9
10#ifndef GrGeometryBuffer_DEFINED
11#define GrGeometryBuffer_DEFINED
12
13#include "GrResource.h"
14
15class GrGpu;
16
17/**
18 * Parent class for vertex and index buffers
19 */
20class GrGeometryBuffer : public GrResource {
21public:
robertphillips@google.com6a644b92012-09-11 13:02:31 +0000[diff] [blame]22 SK_DECLARE_INST_COUNT(GrGeometryBuffer);
bsalomon@google.com3f30e3a2011-10-12 19:53:16 +0000[diff] [blame]23
24 /**
25 *Retrieves whether the buffer was created with the dynamic flag
26 *
27 * @return true if the buffer was created with the dynamic flag
28 */
29 bool dynamic() const { return fDynamic; }
30
31 /**
bsalomon@google.com407c7872013-02-21 14:33:46 +0000[diff] [blame]32 * Returns true if the buffer is a wrapper around a CPU array. If true it
33 * indicates that lock will always succeed and will be free.
34 */
35 bool isCPUBacked() const { return fCPUBacked; }
36
37 /**
bsalomon@google.com3f30e3a2011-10-12 19:53:16 +0000[diff] [blame]38 * Locks the buffer to be written by the CPU.
39 *
40 * The previous content of the buffer is invalidated. It is an error
41 * to draw from the buffer while it is locked. It is an error to call lock
bsalomon@google.com407c7872013-02-21 14:33:46 +0000[diff] [blame]42 * on an already locked buffer. It may fail if the backend doesn't support
43 * locking the buffer. If the buffer is CPU backed then it will always
44 * succeed and is a free operation. Must be matched by an unlock() call.
45 * Currently only one lock at a time is supported (no nesting of
46 * lock/unlock).
bsalomon@google.com3f30e3a2011-10-12 19:53:16 +0000[diff] [blame]47 *
48 * @return a pointer to the data or NULL if the lock fails.
49 */
50 virtual void* lock() = 0;
51
52 /**
53 * Returns the same ptr that lock() returned at time of lock or NULL if the
54 * is not locked.
55 *
56 * @return ptr to locked buffer data or undefined if buffer is not locked.
57 */
58 virtual void* lockPtr() const = 0;
59
60 /**
61 * Unlocks the buffer.
62 *
63 * The pointer returned by the previous lock call will no longer be valid.
64 */
65 virtual void unlock() = 0;
66
67 /**
68 Queries whether the buffer has been locked.
69
70 @return true if the buffer is locked, false otherwise.
71 */
72 virtual bool isLocked() const = 0;
73
74 /**
75 * Updates the buffer data.
76 *
77 * The size of the buffer will be preserved. The src data will be
bsalomon@google.com407c7872013-02-21 14:33:46 +0000[diff] [blame]78 * placed at the beginning of the buffer and any remaining contents will
bsalomon@google.com3f30e3a2011-10-12 19:53:16 +0000[diff] [blame]79 * be undefined.
80 *
81 * @return returns true if the update succeeds, false otherwise.
82 */
83 virtual bool updateData(const void* src, size_t srcSizeInBytes) = 0;
84
85 // GrResource overrides
86 virtual size_t sizeInBytes() const { return fSizeInBytes; }
87
88protected:
bsalomon@google.com407c7872013-02-21 14:33:46 +0000[diff] [blame]89 GrGeometryBuffer(GrGpu* gpu, bool isWrapped, size_t sizeInBytes, bool dynamic, bool cpuBacked)
bsalomon@google.com55dcfe82013-01-23 20:25:22 +0000[diff] [blame]90 : INHERITED(gpu, isWrapped)
bsalomon@google.com3f30e3a2011-10-12 19:53:16 +0000[diff] [blame]91 , fSizeInBytes(sizeInBytes)
bsalomon@google.com407c7872013-02-21 14:33:46 +0000[diff] [blame]92 , fDynamic(dynamic)
93 , fCPUBacked(cpuBacked) {}
bsalomon@google.com3f30e3a2011-10-12 19:53:16 +0000[diff] [blame]94
95private:
96 size_t fSizeInBytes;
97 bool fDynamic;
bsalomon@google.com407c7872013-02-21 14:33:46 +0000[diff] [blame]98 bool fCPUBacked;
bsalomon@google.com3f30e3a2011-10-12 19:53:16 +0000[diff] [blame]99
100 typedef GrResource INHERITED;
101};
102
103#endif