1 //
2 // Copyright 2021 The ANGLE Project Authors. All rights reserved.
3 // Use of this source code is governed by a BSD-style license that can be
4 // found in the LICENSE file.
5 //
6 // CLBuffer.h: Defines the cl::Buffer class, which is a collection of elements.
7
8 #ifndef LIBANGLE_CLBUFFER_H_
9 #define LIBANGLE_CLBUFFER_H_
10
11 #include "libANGLE/CLMemory.h"
12
13 namespace cl
14 {
15
16 class Buffer final : public Memory
17 {
18 public:
19 // Front end entry functions, only called from OpenCL entry points
20
21 static bool IsValid(const _cl_mem *buffer);
22
23 cl_mem createSubBuffer(MemFlags flags,
24 cl_buffer_create_type createType,
25 const void *createInfo);
26
27 bool isRegionValid(size_t offset, size_t size) const;
28 bool isRegionValid(const cl_buffer_region ®ion) const;
29
30 public:
31 ~Buffer() override;
32
33 MemObjectType getType() const final;
34
35 bool isSubBuffer() const;
36
37 private:
38 Buffer(Context &context, PropArray &&properties, MemFlags flags, size_t size, void *hostPtr);
39
40 Buffer(Buffer &parent, MemFlags flags, size_t offset, size_t size);
41
42 friend class Object;
43 };
44
IsValid(const _cl_mem * buffer)45 inline bool Buffer::IsValid(const _cl_mem *buffer)
46 {
47 return Memory::IsValid(buffer) && buffer->cast<Memory>().getType() == MemObjectType::Buffer;
48 }
49
isRegionValid(size_t offset,size_t size)50 inline bool Buffer::isRegionValid(size_t offset, size_t size) const
51 {
52 return offset < mSize && offset + size <= mSize;
53 }
54
isRegionValid(const cl_buffer_region & region)55 inline bool Buffer::isRegionValid(const cl_buffer_region ®ion) const
56 {
57 return region.origin < mSize && region.origin + region.size <= mSize;
58 }
59
getType()60 inline MemObjectType Buffer::getType() const
61 {
62 return MemObjectType::Buffer;
63 }
64
isSubBuffer()65 inline bool Buffer::isSubBuffer() const
66 {
67 return mParent != nullptr;
68 }
69
70 } // namespace cl
71
72 #endif // LIBANGLE_CLBUFFER_H_
73