All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
buffer.h
1 //
2 // Copyright 2020 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_IMAGING_HGI_GL_BUFFER_H
25 #define PXR_IMAGING_HGI_GL_BUFFER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hgiGL/api.h"
29 #include "pxr/imaging/hgi/buffer.h"
30 
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
38 class HgiGLBuffer final : public HgiBuffer
39 {
40 public:
41  HGIGL_API
42  ~HgiGLBuffer() override;
43 
44  HGIGL_API
45  size_t GetByteSizeOfResource() const override;
46 
47  HGIGL_API
48  uint64_t GetRawResource() const override;
49 
50  HGIGL_API
51  void* GetCPUStagingAddress() override;
52 
53  uint32_t GetBufferId() const {return _bufferId;}
54 
55 protected:
56  friend class HgiGL;
57 
58  HGIGL_API
59  HgiGLBuffer(HgiBufferDesc const & desc);
60 
61 private:
62  HgiGLBuffer() = delete;
63  HgiGLBuffer & operator=(const HgiGLBuffer&) = delete;
64  HgiGLBuffer(const HgiGLBuffer&) = delete;
65 
66  uint32_t _bufferId;
67  void* _mapped;
68  void* _cpuStaging;
69 };
70 
71 
72 PXR_NAMESPACE_CLOSE_SCOPE
73 
74 #endif
Represents an OpenGL GPU buffer resource.
Definition: buffer.h:38
HGIGL_API void * GetCPUStagingAddress() override
Returns the 'staging area' in which new buffer data is copied before it is flushed to GPU...
HGIGL_API size_t GetByteSizeOfResource() const override
Returns the byte size of the GPU buffer.
OpenGL implementation of the Hydra Graphics Interface.
Definition: hgi.h:53
Describes the properties needed to create a GPU buffer.
Definition: buffer.h:62
HGIGL_API uint64_t GetRawResource() const override
This function returns the handle to the Hgi backend's gpu resource, cast to a uint64_t.
Represents a graphics platform independent GPU buffer resource (base class).
Definition: buffer.h:98